SUMMARY.md

Table of contents

• adidas API Guidelines

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
  • OpenAPI Specification
  • API Design Platform
  • Design Maturity
  • Testing
• Protocol
  • HTTP
  • TLS
  • Separate Concerns
  • Request Methods
  • Status Codes
• Message
  • Message Formats
  • Content Negotiation
  • HAL
  • Problem Detail
  • Foreign Key Relations
• Application
  • Corporate Data Model
  • Common Data Types
• Execution
  • Pagination
  • Long Running Tasks
    • Polling
    • Callback
    • Files Upload
  • Batch Operations
  • Search Requests
  • Query Requests with Large Inputs
  • Choosing Fields and Embedded Resources
  • Localization
  • Rate Limiting
  • Caching
  • Testing Enviroments
• Evolution
  • Naming Conventions
  • Reserved Identifiers
  • URI Structure
  • Changes and Versioning
  • Phasing out Old Versions
• Guides
  • API Testing CI Environment
  • Complete API Development
• API Clients
  • Loose Coupling
• Further References

Asynchronous API Guidelines

• Introduction
• Core Asynchronous Principles
  • Event Driven Architectures
  • Messages
    • Commands
    • Queries
    • Events
      • Events as Notifications
      • Events to Replicate Data
  • Protocols
  • Coupling
  • Bounded Context
  • Stream Processing
  • Naming Conventions
  • Tooling
    • Editors
    • Command Line Interface (CLI)
    • Generators
• Kafka Asynchronous Guidelines
  • Introduction
    • Why AsyncAPI?
  • AsyncAPI Version
  • Internal vs Public Specifications
  • Key/Value Format
  • Message Headers
  • Specification Granularity
  • Self-Contained Specifications
    • Meaningful Descriptions
  • Schema Data Evolution
    • Backward Compatibility
    • Forward Compatibility
    • Full Compatibility
  • Automatic Schema Registration
  • Contact Information
  • AsyncAPI ID
  • Servers
  • Channels
  • Schemas
  • Security Schemes
  • External Docs