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-2: No subject

Browse Source
This commit is contained in:
Cesareo
2024-05-10 09:32:22 +00:00
committed by gitbook-bot
parent 2a0df79e63
commit b1e72ce21d
70 changed files with 529 additions and 676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
SUMMARY.md
View File

@@ -7,17 +7,20 @@
* [Introduction](general-guidelines/general-guidelines.md)
* [API First](general-guidelines/api-first.md)
* [Contract](general-guidelines/contract.md)
* [Immutability](general-guidelines/c\_immutability.md)
* [Robustness](general-guidelines/robustness.md)
* [Common Data Types](general-guidelines/d\_data\_types.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)
* [Tooling](general-guidelines/n\_tooling.md)
## REST API Guidelines
* [Introduction](rest-api-guidelines/rest.md)
* [Core Principles](rest-api-guidelines/core-principles/README.md)
* [Core REST 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/design-platform.md)
* [Design Maturity](rest-api-guidelines/core-principles/design-maturity.md)
@@ -66,35 +69,42 @@
## Asynchronous API Guidelines
* [Introduction to guidelines](asynchronous-api-guidelines/01_introduction/a_introduction.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/a_introduction.md)
* [AsyncAPI version](asynchronous-api-guidelines/03_asyncapi_kafka_specs/b_asyncapi_version.md)
* [Internal vs Public specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/c_internal_public_specs.md)
* [Spec granularity](asynchronous-api-guidelines/03_asyncapi_kafka_specs/d_spec_granularity.md)
* [Meaningful descriptions](asynchronous-api-guidelines/03_asyncapi_kafka_specs/e_meaningful_descriptions.md)
* [Self-contained specs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/f_self_contained_specs.md)
* [Contact Information](asynchronous-api-guidelines/03_asyncapi_kafka_specs/g_contact_information.md)
* [AsyncAPI ID](asynchronous-api-guidelines/03_asyncapi_kafka_specs/h_asyncapi_id.md)
* [Servers](asynchronous-api-guidelines/03_asyncapi_kafka_specs/i_servers.md)
* [Channels](asynchronous-api-guidelines/03_asyncapi_kafka_specs/j_channels.md)
* [Schemas](asynchronous-api-guidelines/03_asyncapi_kafka_specs/k_schemas.md)
* [Security Schemes](asynchronous-api-guidelines/03_asyncapi_kafka_specs/l_security_schemes.md)
* [External Docs](asynchronous-api-guidelines/03_asyncapi_kafka_specs/m_external_docs.md)
* [Tooling](asynchronous-api-guidelines/03_asyncapi_kafka_specs/n_tooling.md)
* [Introduction](asynchronous-api-guidelines/01\_introduction/a\_introduction.md)
* [Core Asynchronous Principles](asynchronous-api-guidelines/core-asynchronous-principles/README.md)
* [Event Driven Architectures](asynchronous-api-guidelines/core-asynchronous-principles/b\_basic\_concepts\_edas.md)
* [Events](asynchronous-api-guidelines/core-asynchronous-principles/d\_basic\_concepts\_events/README.md)
* [Events as Notifications](asynchronous-api-guidelines/core-asynchronous-principles/d\_basic\_concepts\_events/events-as-notifications.md)
* [Events to Replicate Data](asynchronous-api-guidelines/core-asynchronous-principles/d\_basic\_concepts\_events/events-to-replicate-data.md)
* [Protocols](asynchronous-api-guidelines/core-asynchronous-principles/j\_protocols.md)
* [Commands](asynchronous-api-guidelines/core-asynchronous-principles/commands.md)
* [Query](asynchronous-api-guidelines/core-asynchronous-principles/query.md)
* [Coupling](asynchronous-api-guidelines/core-asynchronous-principles/coupling.md)
* [Bounded Context](asynchronous-api-guidelines/core-asynchronous-principles/bounded-context.md)
* [Stream Processing](asynchronous-api-guidelines/core-asynchronous-principles/stream-processing.md)
* [Naming Conventions](asynchronous-api-guidelines/core-asynchronous-principles/i\_naming\_conventions.md)
* [Tooling](asynchronous-api-guidelines/core-asynchronous-principles/tooling/README.md)
* [Editors](asynchronous-api-guidelines/core-asynchronous-principles/tooling/editors.md)
* [Command Line Interface (CLI)](asynchronous-api-guidelines/core-asynchronous-principles/tooling/command-line-interface-cli.md)
* [Generators](asynchronous-api-guidelines/core-asynchronous-principles/tooling/generators.md)
* [Kafka Asynchronous Guidelines](asynchronous-api-guidelines/kafka-asynchronous-guidelines/README.md)
* [Introduction](asynchronous-api-guidelines/kafka-asynchronous-guidelines/a\_introduction/README.md)
* [Why AsyncAPI?](asynchronous-api-guidelines/kafka-asynchronous-guidelines/a\_introduction/why-asyncapi.md)
* [AsyncAPI Version](asynchronous-api-guidelines/kafka-asynchronous-guidelines/b\_asyncapi\_version.md)
* [Internal vs Public Specifications](asynchronous-api-guidelines/kafka-asynchronous-guidelines/c\_internal\_public\_specs.md)
* [Key/Value Format](asynchronous-api-guidelines/kafka-asynchronous-guidelines/g\_key\_value\_format.md)
* [Message Headers](asynchronous-api-guidelines/kafka-asynchronous-guidelines/h\_message\_headers.md)
* [Specification Granularity](asynchronous-api-guidelines/kafka-asynchronous-guidelines/d\_spec\_granularity.md)
* [Meaningful Descriptions](asynchronous-api-guidelines/kafka-asynchronous-guidelines/e\_meaningful\_descriptions.md)
* [Self-Contained Specifications](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_self\_contained\_specs.md)
* [Schema Data Evolution](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/README.md)
* [Backward Compatibility](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/backward-compatibility.md)
* [Forward Compatibility](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/forward-compatibility.md)
* [Full Compatibility](asynchronous-api-guidelines/kafka-asynchronous-guidelines/f\_schema\_data\_evolution/full-compatibility.md)
* [Automatic Schema Registration](asynchronous-api-guidelines/kafka-asynchronous-guidelines/e\_schema\_registration.md)
* [Contact Information](asynchronous-api-guidelines/kafka-asynchronous-guidelines/g\_contact\_information.md)
* [AsyncAPI ID](asynchronous-api-guidelines/kafka-asynchronous-guidelines/h\_asyncapi\_id.md)
* [Servers](asynchronous-api-guidelines/kafka-asynchronous-guidelines/i\_servers.md)
* [Channels](asynchronous-api-guidelines/kafka-asynchronous-guidelines/j\_channels.md)
* [Schemas](asynchronous-api-guidelines/kafka-asynchronous-guidelines/k\_schemas.md)
* [Security Schemes](asynchronous-api-guidelines/kafka-asynchronous-guidelines/l\_security\_schemes.md)
* [External Docs](asynchronous-api-guidelines/kafka-asynchronous-guidelines/m\_external\_docs.md)