mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
70 lines
4.2 KiB
Markdown
70 lines
4.2 KiB
Markdown
# 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/apiary.md)
|
|
* [Design Maturity](rest-api-guidelines/core-principles/design-maturity.md)
|
|
* [Testing](rest-api-guidelines/core-principles/testing.md)
|
|
* [Functionality](rest-api-guidelines/functionality/README.md)
|
|
* [Protocol](rest-api-guidelines/functionality/protocol/README.md)
|
|
* [HTTP](rest-api-guidelines/functionality/protocol/http.md)
|
|
* [TLS](rest-api-guidelines/functionality/protocol/tls.md)
|
|
* [Separate Concerns](rest-api-guidelines/functionality/protocol/separate-concerns.md)
|
|
* [Request Methods](rest-api-guidelines/functionality/protocol/use-appropriate-methods.md)
|
|
* [Status Codes](rest-api-guidelines/functionality/protocol/use-appropriate-status-codes.md)
|
|
* [Message](rest-api-guidelines/functionality/message/README.md)
|
|
* [Message Formats](rest-api-guidelines/functionality/message/message-formats.md)
|
|
* [Content Negotiation](rest-api-guidelines/functionality/message/content-negotiation.md)
|
|
* [HAL](rest-api-guidelines/functionality/message/hal.md)
|
|
* [Problem Detail](rest-api-guidelines/functionality/message/error-reporting.md)
|
|
* [Foreign Key Relations](rest-api-guidelines/functionality/message/foreign-key-relations.md)
|
|
* [Application](rest-api-guidelines/functionality/application/README.md)
|
|
* [Corporate Data Model](rest-api-guidelines/functionality/application/harmonize-data.md)
|
|
* [Common Data Types](rest-api-guidelines/functionality/application/common-data-types.md)
|
|
* [Quality](rest-api-guidelines/quality/README.md)
|
|
* [Execution](rest-api-guidelines/quality/execution/README.md)
|
|
* [Pagination](rest-api-guidelines/quality/execution/pagination.md)
|
|
* [Asynchronous Tasks](rest-api-guidelines/quality/execution/asynchronous-tasks.md)
|
|
* [Batch Operations](rest-api-guidelines/quality/execution/batch-operations.md)
|
|
* [Search Requests](rest-api-guidelines/quality/execution/search-requests.md)
|
|
* [Query Requests with Large Inputs](rest-api-guidelines/quality/execution/query-requests-with-large-inputs.md)
|
|
* [Choosing Fields and Embedded Resources](rest-api-guidelines/quality/execution/choosing-fields-and-embedded-resoruces.md)
|
|
* [Localization](rest-api-guidelines/quality/execution/localization.md)
|
|
* [Rate Limiting](rest-api-guidelines/quality/execution/rate-limiting.md)
|
|
* [Caching](rest-api-guidelines/quality/execution/caching.md)
|
|
* [Testing Enviroments](rest-api-guidelines/quality/execution/testing-enviroments.md)
|
|
* [Evolution](rest-api-guidelines/quality/evolution/README.md)
|
|
* [Naming Conventions](rest-api-guidelines/quality/evolution/naming-conventions.md)
|
|
* [Reserved Identifiers](rest-api-guidelines/quality/evolution/reserved-identifiers.md)
|
|
* [URI Structure](rest-api-guidelines/quality/evolution/uri-structure.md)
|
|
* [Changes and Versioning](rest-api-guidelines/quality/evolution/versioning.md)
|
|
* [Phasing out Old Versions](rest-api-guidelines/quality/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)
|
|
|
|
## Kafka Guidelines
|
|
|
|
* [Introduction](kafka-guidelines/kafka.md)
|
|
|