For each topic, a cheatsheet should show:

• A TL;DR for the topic
• Quick links to useful resources
• An example flow/entity diagram
• Commands to quickly demonstrate the concept

What is an API?

An ‘application programming interface' is an interface that makes it easy for one application to ‘consume' capabilities or data from another application.

APIs as Products?

The API Product Mindset

The API Product Deconstructed

Developer Experience

• In 5 seconds, the developer should know what an API does
• In 5 minutes, the developer should have make a successful request
• In 5 days, the developer should have taken their app to production

If they cannot use your APIs, they will look elsewhere.

Features of API Management

• Analytics
• Traffic Management
• Developer Engagment
• Monetization
• Security
• Orchestration
• Mediation

TODO

Identity

All use cases require some form of identity. We must identify whether to use API Keys, one of the OAuth 2 grant types, Open ID Connect etc.

Business Value

TODO

TODO

Building an API Team

TODO

User Stories

TODO

DoR and DoD

TODO

Example Backlog

TODO

TODO

Local Tools

TODO

Remote Tools

• Git
• Node JS
• Maven
• Apigee Edge Environment
• Logging

Demo

Build and Deploy Tools

• UI
• Management API
• apigeetool
• Maven Plugin

Linting

• eslint
• bundle-linters

Unit Testing

• junit
• mocha

Integration Testing

• apickli

Performance Benchmarking

• apachebench

Dev Portal Publishing

• d8 rest api

Publish Results and Notify

• jenkins reports
• email + slack notifications

TODO

Organizations and Environments

Design

Physical Separation

• Regions
• Traffic Isolation
• PCI + HIPAA

TODO

Organizations and Environments

TODO

Deployment Options

TODO

TODO

Topology Design

• Reference Topologies
• Estimator
• etp

Installation and Provisioning

• shell scripts
• ansible

TODO

• swagger mock
• apimocker
• assign message

• apickli

• spike vs quota

• out of the box
• stats collector
• custom reports
• async reports

(int/ext generated)

• API Key
• Basic Auth
• OAuth 2
  
  
  • Client Credentials
  • Password
  • Auth Code
  • Implicit
• OIDC
  
  
  • auth code
  • implicit
  • hybrid
• Extensions
  
  
  • proof of possession
  • pkce
  • device flow
  • eidas
  • token by SAML
• SAML

• TLS
• Audit
• RBAC
• Content Based Protection
• Traffic Mgmt
• SIEM integration

TODO

TODO

• Integrated
• D7
• D8
• Roll your own

TODO