Concepts
Nine ideas appear on every screen of API-dex. Each page below explains one of them in a few paragraphs. For the end-to-end picture, start with How API-dex works.
A configured connection from API-dex to one gateway, and why everything you see is scoped to one.
Apigee, Gravitee and Azure API Management, the gateways an environment connects to.
Consumer teams and backend teams, and how membership works.
Organisation-wide access patterns that tie teams to the APIs they may call.
A client registration for calling APIs: credentials plus the APIs it subscribes to.
The APIs published to the current environment, and how consumers and producers relate to them.
One canonical specification plus a translation overlay per language, applied when someone reads it.
Consuming and producing users, and the roles API-dex recognises.
Why two signed-in people can see different menus.
How they fit together
- An administrator registers an environment for each gateway and defines permission groups.
- A producer on a backend team publishes an API to the catalog of one environment.
- A consumer creates an application, subscribes it to the API and receives credentials. Their consumer team shares the application.
- Each person's role decides which of these screens they see.