mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
8.2 KiB
8.2 KiB
Table of contents
General Guidelines
- Introduction
- API First
- Contract
- Immutability
- Robustness
- Common Data Types
- Version Control System
- Minimal API Surface
- Rules for Extending
- JSON
- Security
- Tooling
REST API Guidelines
- Introduction
- Core REST Principles
- Protocol
- Message
- Application
- Execution
- Evolution
- Guides
- API Clients
- Further References
Asynchronous API Guidelines
- Introduction
- Core Asynchronous Principles
- Kafka Asynchronous Guidelines
- Introduction
- AsyncAPI Version
- Internal vs Public Specifications
- Key/Value Format
- Message Headers
- Specification Granularity
- Meaningful Descriptions
- Self-Contained Specifications
- Schema Data Evolution
- Automatic Schema Registration
- Contact Information
- AsyncAPI ID
- Servers
- Channels
- Schemas
- Security Schemes
- External Docs