Within the portal, documentation is what a developer can use to learn how to access and use your APIs.
The developer portal supports two types of documentation, and will render them differently:
- API Blueprint – this is rendered to HTML templates using Jade and Aglio.
- Swagger (OpenAPI) – this is rendered using SwaggerUI and also offers a sandbox environment where developers can interact with your API easily from the browser.
Within an API Catalogue entry, documentation must be “Attached” to the catalogue entry for it to be published.