Cisco REST API Design Guide

Guidelines for Designing REST APIs at Cisco, developed across Cisco DevNet, Collaboration, and the Application Platform Group. Emphasizes "API-only" communication, aesthetic and behavioral consistency, OAuth2 / HTTPS security, and avoidance of internal vs. partner API bifurcation.

API entry from apis.yml

apis.yml Raw ↑
aid: style-guides:cisco
name: Cisco REST API Design Guide
description: Guidelines for Designing REST APIs at Cisco, developed across Cisco DevNet, Collaboration,
  and the Application Platform Group. Emphasizes "API-only" communication, aesthetic and behavioral consistency,
  OAuth2 / HTTPS security, and avoidance of internal vs. partner API bifurcation.
humanURL: https://github.com/CiscoDevNet/api-design-guide
baseURL: https://raw.githubusercontent.com/CiscoDevNet/api-design-guide/master/
tags:
- REST
- Cisco
- DevNet
- OAuth2
properties:
- type: StyleGuide
  url: https://github.com/CiscoDevNet/api-design-guide
- type: GitHubRepository
  url: https://github.com/CiscoDevNet/api-design-guide
- type: Scope
  data:
    surfaces:
    - REST
    publisher: Cisco Systems
    license: see repository (Cisco copyright 2015-2024)
    status: living