English

العربية

English

العربية

Appearance

API catalog ​

The APIs area lists the APIs published to the current environment. Each API's page shows its description, its versions, the backend team that owns it and its interactive OpenAPI specification. When more than one version exists, Compare versions shows a structured diff between any two.

  • Consumers subscribe their applications to an API so they can call it.
  • Producers upload specifications and assign each API to the backend team that owns it.

Ownership is shown on every API, so consumers know who to contact for changes or incidents.

Translated specifications ​

Not yet released

Translated specifications ship in a release after API-dex 3.1.0.

A specification can carry a translation per portal language. Producers publish the canonical specification once, plus an overlay per language containing only translated titles, summaries and descriptions. API-dex merges the matching overlay in when a consumer opens the specification, so the stored specification never changes and the translated file downloads as a valid OpenAPI document. See Translated specifications for the model and Translating a specification for the steps.