OpenAPI Swagger Viewer for Confluence

Show your OpenAPI or Swagger spec on a Confluence page, in one macro

OpenAPI Swagger Viewer for Confluence turns an OpenAPI 3.1, 3.0 or Swagger 2.0 file (YAML or JSON) into a readable, searchable API reference right on the page. Engineers read the real spec, not a screenshot, and the page cannot drift away from the file in your repository.

Built on Atlassian Forge and designed to Run on Atlassian: no external servers, no external permissions, no credentials stored.

What it does

Renders paths, operations, parameters, request and response bodies, schemas and security schemes.
Supports OpenAPI 3.1, 3.0.x and Swagger 2.0, in YAML or JSON.
Shows a clear error with the line number when a spec is invalid, instead of a blank box.
Free for sites up to 10 users, 30-day trial for larger sites, billed through Atlassian.

Two ways to get your spec onto the page

Paste. Paste the spec into the macro settings (up to about 150 KB). Good for small APIs and quick drafts.
Page attachment. Attach a .yaml, .yml or .json file to the page and pick it in the macro. Choose “always latest” so the page follows new versions, or pin a version for a released API. There is no app-imposed limit beyond your site’s attachment size. Attachment mode guide.

Private repositories: let your CI push the spec

Most Confluence viewers need to log in to your repository, which means handing a token to a third party. We do the opposite. Your pipeline (GitHub Actions, GitLab CI, Bitbucket Pipelines or a plain curl command) uploads the spec as a page attachment using your own Confluence API token. The macro renders the newest version on the next page load.

The app never connects to your repository.
The app never sees or stores your token.
One pipeline step, copy-paste snippets in the documentation.

Made for readers

Expand and collapse operations, filter by tag, search within the spec.
Deep links to a single operation.
Full-screen view for long specs.
Fits the page width and height with no inner scrollbar or truncation.
Follows the Confluence light and dark themes.

Runs on Atlassian

The app declares no external permissions and makes no outbound requests, so it qualifies for the Runs on Atlassian badge. Your spec is parsed and rendered in your own browser. It is never sent to us or to any third party. Macro settings and anonymous error counters live in Atlassian’s Forge storage, which stays in your site’s data-residency region. Uninstalling removes the app’s data according to Atlassian’s retention schedule. Details are in the Privacy Policy.

What it does not do, and why

No “Try it out” button. Sending live requests from the page would require external permissions and would end the Runs on Atlassian guarantee. Test calls in Postman, curl or your gateway console.
No loading a spec from a URL or a repository. The same reason applies: it would mean outbound traffic. Use the CI push instead, which also works for private repositories.
No spec editing. This is a viewer.
External $ref links to other files are not resolved yet. Bundle your spec into one file (for example with Redocly CLI). Resolving sibling attachments is planned as a fast follow.
Confluence Cloud only. Atlassian Forge does not exist for Data Center.

If you need live calls or URL loading badly enough, tell us at support@capella.business. We only build a separate edition if enough customers ask.

Pricing

Free for up to 10 users; paid tiers via Atlassian Marketplace.

Larger sites are priced per user tier. Current prices are on the Marketplace listing.
30-day free trial.
Billing, invoices and refunds are handled by Atlassian.

See pricing on Atlassian Marketplace

Moving from another Swagger or OpenAPI macro?

The documentation has a migration guide with a feature map for each app. Connect-based apps stop being supported by Atlassian on 31 January 2027.

Support

Email support@capella.business. No account or sign-up needed. First reply within one business day. See the support page and the documentation.