Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [master] 102 pages and one asset modified

Browse Source
This commit is contained in:
apidesigner
2018-07-23 07:49:01 +00:00
committed by gitbook-bot
parent af88d15fd0
commit 3b81882249
68 changed files with 850 additions and 712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
SUMMARY.md
View File

@@ -1,12 +1,14 @@
# Summary
# Table of contents
* [Introduction](README.md)
## Introduction
* [adidas API Guidelines](README.md)
* [adidas API Guidelines](introduction/readme.md)
## General Guidelines
* [Introduction](general-guidelines/README.md)
* [Introduction](general-guidelines/general-guidelines.md)
* [API First](general-guidelines/api-first.md)
* [Contract](general-guidelines/contract.md)
* [Robustness](general-guidelines/robustness.md)
@@ -18,53 +20,53 @@
## REST API Guidelines
* [Introduction](rest/README.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)
* [Further References](rest/miscellaneous.md)
* [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)
* [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)
* [Testing Enviroments](rest-api-guidelines/quality/evolution/testing-enviroments.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/README.md)
* [Introduction](kafka-guidelines/kafka.md)