Skip to Content
API DocumentAPI Spec

Switch Among Different Viewers

Whether in the API Repository or published API Document site, API Specs are rendered as interactive and beautiful documents that make API endpoint navigation easy.

Beyond the default rendering of API Specs, you can also view them in other formats by clicking the ‘magic’ icon for the selected API spec:

  • Default viewer: Interactive and beautiful API Spec document
  • Swagger viewer: Renders API specs in traditional Swagger UI style
  • Code viewer: Displays the raw spec contents as code
  • Diff reviewer: Compares API specs with other specs in the same repository
  • Governance viewer: Checks the spec for governance rule violations

To switch viewers, click the ‘magic’ icon from the left sidebar and select your preferred viewer.

API Spec - Switch viewer

Try It Out from API Spec

Both our default viewer and Swagger UI viewer provide a “Try it out” function for APIs. You can click this function to interact with the API based on the spec and examine the response.

API Spec - Try it out

Request Snippet Generation

By clicking the “Request Code Snippets” button in the right panel of the API spec, you can generate request code snippets in your preferred programming language.

API Spec - Request code snippet

Code Generation

By clicking the “Generate Code” button in the right panel of the API spec, you can generate code for a specific request body or response in your desired language.

API Spec - Code generation

Last updated on