Skip to main content

Introducing Multiple Response Examples in API Portal

· One min read

To make your API documentation even more comprehensive and user-friendly, we have added support to add multiple examples against each response status code. This includes support for response headers and multiple content types.

Previously, the API Portal supported a single example against a single response code, which restricted in-depth understanding of the expected response behaviors.

With this release, users can add multiple response examples in their API definition files to make them even more detailed for their API consumers. The API portal section for the endpoint responses has been updated to support this change in the API definition and can now display multiple response examples and response headers for the status codes that can be switched via tabs. The UI will also show a hierarchy to show multiple content types containing multiple examples.

Multiple Response Examples