From 3192c067bb87004b6b91a9c92ed36a144b17d288 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Manuel=20P=C3=A9rez?= Date: Mon, 22 Apr 2024 16:52:48 +0200 Subject: [PATCH] Fixed README.md reference and adding an index to asynchronous api guidelines --- README.md | 2 +- asynchronous-api-guidelines/index.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 asynchronous-api-guidelines/index.md diff --git a/README.md b/README.md index 4278112..d9d5851 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ The API Guidelines are split into two main parts: * [General Guidelines](general-guidelines/general-guidelines.md) * API type-specific Guidelines * [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\). diff --git a/asynchronous-api-guidelines/index.md b/asynchronous-api-guidelines/index.md new file mode 100644 index 0000000..3c802e1 --- /dev/null +++ b/asynchronous-api-guidelines/index.md @@ -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) \ No newline at end of file