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
Files
8a5586b25637800cdcf213c4764db66f5f204db0
api-guidelines/asynchronous-api-guidelines/03_asyncapi_kafka_specs/i_servers.md
Juan Manuel Pérez 8a5586b256 Changed structure, splitting content into several files
2024-05-08 16:57:21 +02:00

1.0 KiB
Raw Blame History

adidas Asynchronous API guidelines

AsyncAPI guidelines for Kafka

Servers

All AsyncAPI specs MUST include a servers section including references to the right Kafka clusters, defined and maintained by FDP team and made available through domains in Swaggerhub.

Those definitions are handled in Swaggerhub as reusable domains publicly available:

https://design.api.3stripes.io/domains/adidas/asyncapi_adoption_commons/1.0.0

that can be referred from any spec, picking the right kafka servers as required (see example below).

...
servers:
  pivotalDev:
    $ref: https://design.api.3stripes.io/v1/domains/adidas/asyncapi_adoption_commons/1.0.0#/components/servers/pivotalDev
  pivotalSit:
    $ref: https://design.api.3stripes.io/v1/domains/adidas/asyncapi_adoption_commons/1.0.0#/components/servers/pivotalSit
  pivotalPro:
    $ref: https://design.api.3stripes.io/v1/domains/adidas/asyncapi_adoption_commons/1.0.0#/components/servers/pivotalPro
...

Important note Don't forget to include '/v1/' in the URL of the domain