# Table of contents * [adidas API Guidelines](README.md) ## General Guidelines * [Introduction](general-guidelines/general-guidelines.md) * [API First](general-guidelines/api-first.md) * [Contract](general-guidelines/contract.md) * [Robustness](general-guidelines/robustness.md) * [Version Control System](general-guidelines/version-control-system.md) * [Minimal API Surface](general-guidelines/minimal-api-surface.md) * [Rules for Extending](general-guidelines/rules-for-extending.md) * [JSON](general-guidelines/json.md) * [Security](general-guidelines/security.md) ## REST API Guidelines * [Introduction](rest-api-guidelines/rest.md) * [Core Principles](rest-api-guidelines/core-principles/README.md) * [OpenAPI Specification](rest-api-guidelines/core-principles/openapi-specification.md) * [API Design Platform](rest-api-guidelines/core-principles/design-platform.md) * [Design Maturity](rest-api-guidelines/core-principles/design-maturity.md) * [Testing](rest-api-guidelines/core-principles/testing.md) * [Protocol](rest-api-guidelines/protocol/README.md) * [HTTP](rest-api-guidelines/protocol/http.md) * [TLS](rest-api-guidelines/protocol/tls.md) * [Separate Concerns](rest-api-guidelines/protocol/separate-concerns.md) * [Request Methods](rest-api-guidelines/protocol/use-appropriate-methods.md) * [Status Codes](rest-api-guidelines/protocol/use-appropriate-status-codes.md) * [Message](rest-api-guidelines/message/README.md) * [Message Formats](rest-api-guidelines/message/message-formats.md) * [Content Negotiation](rest-api-guidelines/message/content-negotiation.md) * [HAL](rest-api-guidelines/message/hal.md) * [Problem Detail](rest-api-guidelines/message/error-reporting.md) * [Foreign Key Relations](rest-api-guidelines/message/foreign-key-relations.md) * [Application](rest-api-guidelines/application/README.md) * [Corporate Data Model](rest-api-guidelines/application/harmonize-data.md) * [Common Data Types](rest-api-guidelines/application/common-data-types.md) * [Execution](rest-api-guidelines/execution/README.md) * [Pagination](rest-api-guidelines/execution/pagination.md) * [Long Running Tasks](rest-api-guidelines/execution/long-running-tasks/README.md) * [Polling](rest-api-guidelines/execution/long-running-tasks/polling.md) * [Callback](rest-api-guidelines/execution/long-running-tasks/callback.md) * [Files Upload](rest-api-guidelines/execution/long-running-tasks/files-upload.md) * [Batch Operations](rest-api-guidelines/execution/batch-operations.md) * [Search Requests](rest-api-guidelines/execution/search-requests.md) * [Query Requests with Large Inputs](rest-api-guidelines/execution/query-requests-with-large-inputs.md) * [Choosing Fields and Embedded Resources](rest-api-guidelines/execution/choosing-fields-and-embedded-resoruces.md) * [Localization](rest-api-guidelines/execution/localization.md) * [Rate Limiting](rest-api-guidelines/execution/rate-limiting.md) * [Caching](rest-api-guidelines/execution/caching.md) * [Testing Enviroments](rest-api-guidelines/execution/testing-enviroments.md) * [Evolution](rest-api-guidelines/evolution/README.md) * [Naming Conventions](rest-api-guidelines/evolution/naming-conventions.md) * [Reserved Identifiers](rest-api-guidelines/evolution/reserved-identifiers.md) * [URI Structure](rest-api-guidelines/evolution/uri-structure.md) * [Changes and Versioning](rest-api-guidelines/evolution/versioning.md) * [Phasing out Old Versions](rest-api-guidelines/evolution/phasing-out-old-versions.md) * [Guides](rest-api-guidelines/guides/README.md) * [API Testing CI Environment](rest-api-guidelines/guides/api-testing-ci-environment.md) * [Complete API Development](rest-api-guidelines/guides/complete-api-development.md) * [API Clients](rest-api-guidelines/clients/README.md) * [Loose Coupling](rest-api-guidelines/clients/loose-coupling.md) * [Further References](rest-api-guidelines/miscellaneous.md) ## Asynchronous API Guidelines * [Introduction to guidelines](asynchronous-api-guidelines/01_introduction/a_introduction.md) * Basic Concepts * [Event Driven Architectures](asynchronous-api-guidelines/01_introduction/b_basic_concepts_edas.md) * [Basic terminology](asynchronous-api-guidelines/01_introduction/c_basic_concepts_terminology.md) * [Events](asynchronous-api-guidelines/01_introduction/d_basic_concepts_events.md) * Asynchronous API Guidelines * [Contract](asynchronous-api-guidelines/02_asynchronous_api_guidelines/a_contract.md) * [API First](asynchronous-api-guidelines/02_asynchronous_api_guidelines/b_api_first.md) * [Immutability](asynchronous-api-guidelines/02_asynchronous_api_guidelines/c_immutability.md) * [Common Data Types](asynchronous-api-guidelines/02_asynchronous_api_guidelines/d_data_types.md) * [Automatic Schema Registration](asynchronous-api-guidelines/02_asynchronous_api_guidelines/e_schema_registration.md) * [Schema Data Evolution](asynchronous-api-guidelines/02_asynchronous_api_guidelines/f_schema_data_evolution.md) * [Key/Value format](asynchronous-api-guidelines/02_asynchronous_api_guidelines/g_key_value_format.md) * [Message Headers](asynchronous-api-guidelines/02_asynchronous_api_guidelines/h_message_headers.md) * [Naming Conventions](asynchronous-api-guidelines/02_asynchronous_api_guidelines/i_naming_conventions.md) * [Protocols](asynchronous-api-guidelines/02_asynchronous_api_guidelines/j_protocols.md) * [Security](asynchronous-api-guidelines/02_asynchronous_api_guidelines/k_security.md) * AsyncAPI specs for Kafka * [Introduction](asynchronous-api-guidelines/03_asyncapi_kafka_specs/a_introduction.md) * [AsyncAPI version](asynchronous-api-guidelines/03_asyncapi_kafka_specs/b_asyncapi_version.md) * [Internal vs Public specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/c_internal_public_specs.md) * [Spec granularity](asynchronous-api-guidelines/03_asyncapi_kafka_specs/d_spec_granularity.md) * [Meaningful descriptions](asynchronous-api-guidelines/03_asyncapi_kafka_specs/e_meaningful_descriptions.md) * [Self-contained specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/f_self_contained_specs.md) * [Contact Information](asynchronous-api-guidelines/03_asyncapi_kafka_specs/g_contact_information.md) * [AsyncAPI ID](asynchronous-api-guidelines/03_asyncapi_kafka_specs/h_asyncapi_id.md) * [Servers](asynchronous-api-guidelines/03_asyncapi_kafka_specs/i_servers.md) * [Channels](asynchronous-api-guidelines/03_asyncapi_kafka_specs/j_channels.md) * [Schemas](asynchronous-api-guidelines/03_asyncapi_kafka_specs/k_schemas.md) * [Security Schemes](asynchronous-api-guidelines/03_asyncapi_kafka_specs/l_security_schemes.md) * [External Docs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/m_external_docs.md) * [Tooling](asynchronous-api-guidelines/03_asyncapi_kafka_specs/n_tooling.md)