Documentation

Everything you need to show an OpenAPI or Swagger spec on a Confluence Cloud page, keep it current from CI, and move over from another macro.

Get started

  • Quick start

    Install the app, add the macro, paste a spec and publish. About five minutes.

  • Attachment mode

    Render a .yaml, .yml or .json file attached to the page. Always latest, or pin a version.

  • Push your spec from CI

    Private repository? Your pipeline uploads the spec as an attachment with your own token. Ready-made GitHub Actions, GitLab CI, Bitbucket Pipelines and curl snippets.

Help

  • Troubleshooting

    Parser errors with line numbers, "No attachment found", permission errors, stale content, slow rendering.

  • FAQ

    Why there is no "Try it out", size limits, security and data location, pricing, supported OpenAPI versions.

Migrating from another Swagger macro

Atlassian ends support for Connect apps on 31 January 2027. Start with the migration overview, then follow the guide for your current app: