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