Skip to main content
Better Swagger UI for Confluence is a Forge app with a single Better Swagger UI macro that renders an OpenAPI or Swagger document as an interactive Swagger UI panel — endpoint list, schemas, and a Try it out console — directly inside a Confluence page.

​
Who this is for

API teams who maintain an OpenAPI 2.0 (Swagger) or 3.0 document and want the familiar Swagger UI reference, including the Try it out console, embedded in Confluence instead of linking out to another tool.

​
Prerequisites

  • A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn’t support Data Center)
  • An OpenAPI 2.0 or 3.0 document, as a URL or pasted JSON/YAML
  • Optionally, credentials to pre-authorize Try it out requests (Basic auth or an API key)

​
Get started

1

Install

See Installation for how to add Better Swagger UI for Confluence from the Atlassian Marketplace.
2

Add it to a page

See Usage for how to insert and set up the macro.
3

Configure

See Configuration for the full reference of every field.
Need help? Visit the Better Swagger UI for Confluence service desk portal.