API catalog
The APIs page
| Control | What it does |
|---|---|
| Search by name | Filters the cards by API name |
| Filter by consumption | Both, Already consumed (APIs one of your applications already calls) or Not consumed; select Apply filters or Reset |
| Tags | Each tag on a card is a shortcut that searches for that tag |
| Request access | Opens Add API to your applications: pick one or more of your applications, optionally narrowed by company, and Save. Where the organisation requires approval, the subscription is pending until an administrator approves it |
| Documentation | Opens the API's page |
Administrators configure which fields a catalog card shows under Settings → Catalog. The default card shows the version, description, tags, Requests allowed (quota), rate limit, HTTP methods, contact, latest update and security schemes.
Controls on an API's page
| Control | What it does |
|---|---|
| Version | Switches between the published versions of the specification. Each entry shows the version, (Latest) for the newest, and its publication time |
| Specification | The interactive OpenAPI documentation: servers, Authorize, operations grouped by tag, parameters, responses and schemas, and Try it out where the administrator has enabled it |
| Page menu | The button beside the API title. Contains the items below |
| Download spec | Downloads the specification of the selected version for use in other tools |
| Compare versions | Pick a From version and a To version and read a structured diff of what changed; identical versions report No changes |
Producer and administrator controls
Producing roles and administrators additionally see in the page menu:
| Control | What it does |
|---|---|
| Analyze Spec | Opens Spec Consistency Analysis: a consistency score out of 100 and, per schema in the specification, whether it matches an entry in the organisation's Data Dictionary |
| Assign to backend team | Sets the owning team of a newly uploaded API from a list of backend teams |
| Reassign to another backend team | Moves ownership of an API that is already assigned |
| Delete specs | Removes the API's specifications from the catalog after confirmation |
Not yet released
The Upload spec page (Destination, Specification, Overlays, Review), Override existing version and translation overlays ship in a release after API-dex 3.1.0; see Locale overlays and the Changelog. In the current release, specifications are published with the API-dex CLI or dropped onto the APIs page by a CI/CD account.
Subscribing
An application is subscribed to an API from the API's catalog card with Request access, or from the application's page with Add/Remove APIs. See Reference: applications.
Related topics
- API catalog, the concept
- Consuming an API
- Exposing your API