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

Changed structure, splitting content into several files

Browse Source
This commit is contained in:
Juan Manuel Pérez
2024-05-08 16:57:21 +02:00
parent eac1ded8d1
commit 8a5586b256
30 changed files with 559 additions and 382 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
SUMMARY.md
View File

@@ -67,10 +67,34 @@
## Asynchronous API Guidelines
* [Introduction to guidelines](asynchronous-api-guidelines/01_introduction/a_introduction.md)
* [Basic concepts](asynchronous-api-guidelines/01_introduction/b_basic_concepts.md)
* [General guidelines for asynchronous APIs](asynchronous-api-guidelines/02_asynchronous_api_guidelines/main.md)
* [Introduction to AsyncAPI specs for Kafka](asynchronous-api-guidelines/03_asyncapi_kafka_specs/a_introduction.md)
* [Guidelines for AsyncAPI specs for Kafka](asynchronous-api-guidelines/03_asyncapi_kafka_specs/b_guidelines.md)
* [Tooling for AsyncAPI](asynchronous-api-guidelines/03_asyncapi_kafka_specs/c_tooling.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)
* [AsyncAPI version](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Internal vs Public specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Spec granularity](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Meaningful descriptions](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Self-contained specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Contact Information](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [AsyncAPI ID](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Servers](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Channels](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Schemas](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Security Schemes](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [External Docs](asynchronous-api-guidelines/03_asyncapi_kafka_specs)
* [Tooling](asynchronous-api-guidelines/03_asyncapi_kafka_specs)