Exposing your API
This guide is for producing roles: a member of a backend team, or an account using the CI/CD role. For a full first-time walkthrough, including creating the team, see Publish your first API. Use this page once you know the steps and need the short version.
Select the environment
Open the environment control in the top bar and choose the environment your API is deployed to. The upload and the catalog entry are scoped to it.
Open APIs
Open APIs from the main navigation.
Upload the specification
From a pipeline, run apidex-cli upload-spec with a CI/CD account. In the browser, a CI/CD account drags the OpenAPI file onto the upload area on the APIs page. Both produce the same catalog entry. Administrators and backend-team members without the CI/CD role do not see an upload control.
Assign it to a backend team
Open the API, open the page menu (the button beside the title) and select Assign to backend team, then choose the team. Select Reassign to another backend team when it is already assigned. The owning team is what consumers see as the contact for changes and incidents.
Verify it is in the catalog
Return to APIs. The API is listed for this environment with its specification viewable.
Not yet released
The four-step Upload spec page, with translation overlays per portal language, ships in a release after API-dex 3.1.0. See Translating a specification and the Changelog.
INFO
Consumers find the API from APIs, read the specification and subscribe their applications to it. See Consuming an API.
Related topics
- Managing your teams, when the backend team does not exist yet
- Reference: API catalog, every control on an API's page