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

Fixed README.md reference and adding an index to asynchronous api guidelines

Browse Source
This commit is contained in:
Juan Manuel Pérez
2024-04-22 16:52:48 +02:00
parent 153f933dc2
commit 3192c067bb
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -23,7 +23,7 @@ The API Guidelines are split into two main parts:
* [General Guidelines](general-guidelines/general-guidelines.md) * [General Guidelines](general-guidelines/general-guidelines.md)
* API type-specific Guidelines * API type-specific Guidelines
* [REST APIs Guidelines](rest-api-guidelines/rest.md) * [REST APIs Guidelines](rest-api-guidelines/rest.md)
* [Asynchronous APIs Guidelines](asynchronous-api-guidelines/asyncapi.md) * [Asynchronous APIs Guidelines](asynchronous-api-guidelines/index.md)
The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique \(such as REST, Kafka or GraphQL APIs\). The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique \(such as REST, Kafka or GraphQL APIs\).

10
asynchronous-api-guidelines/index.md Normal file
View File

@@ -0,0 +1,10 @@
## Asynchronous API Guidelines
* Preliminary concepts
* [Introduction](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)
* AsyncAPI specs for Kafka
* [Introduction](asynchronous-api-guidelines/03_asyncapi_kafka_specs/a_introduction.md)
* [Guidelines](asynchronous-api-guidelines/03_asyncapi_kafka_specs/b_guidelines.md)
* [Tooling](asynchronous-api-guidelines/03_asyncapi_kafka_specs/c_tooling.md)