Built on Forge · Runs on Atlassian

OpenAPI docs in Confluence that tell you what broke

Turn any OpenAPI 3.0, 3.1 or Swagger 2.0 spec into interactive API reference on a Confluence page. Every update is versioned, and breaking changes are flagged automatically.

Marketplace listing coming soon. Free 30-day trial at launch. Already using GitHub? Try the free GitHub Action.

API reference for an example Payments API rendered in a Confluence page

Everything your API readers need, nothing they don't

Built for teams moving off unsupported Connect apps and for anyone tired of pasting screenshots of Swagger UI into Confluence.

OpenAPI 3.1 support

OpenAPI 3.0 and 3.1, Swagger 2.0, JSON or YAML. Webhooks, oneOf/anyOf, nullable types and $ref all render properly.

Breaking-change detection

Removed operations, newly required parameters, changed types, dropped auth schemes and more, compared between any two versions.

Your specs stay in Confluence

Specs are stored as page attachments with version history. No external storage, no tokens to leak, no data egress.

Filter what you show

Choose tags or path patterns, and hide base URLs, deprecated operations or the API description, so one spec can feed many pages.

Code samples

cURL, JavaScript and Python requests for every operation, including auth headers, ready to copy.

Export-ready

Full-screen view for large APIs, plus a clean endpoint table when a page is exported to PDF or Word.

Catch breaking changes before your consumers do

Upload a new version of the spec and the macro compares it with the previous one. Changes are grouped by operation and graded:

  • Breaking: removed operations, newly required fields and parameters, removed auth schemes.
  • Warning: new enum values and other changes that strict clients may reject.
  • Info: additive, non-breaking changes.

Pick any two attachment versions to compare release against release.

What changed panel listing four breaking changes and four warnings between two spec versions

Readable reference, not a wall of JSON

Operations are grouped by tag and searchable. Each one shows parameters, request bodies, responses with headers, nested schemas, enum values and examples, next to a generated code sample.

Expanded GET /payments operation with parameters, response schema and a cURL sample

Set up in under a minute

Type /OpenAPI in the editor. Pick an existing attachment, paste a spec, or upload a file, and a live preview updates as you configure.

While editing, spec-quality notes point out missing summaries, undocumented responses and other gaps.

Macro configuration panel with source picker, tag and path filters, and live preview

Runs on Atlassian

The app is built entirely on Atlassian Forge. It does not call any external servers, so your API specifications and page content never leave Atlassian's infrastructure and inherit your site's data residency.

No external egressNo third-party storageActs as the viewing userRespects page permissions

Security details →