Coming to the Atlassian Marketplace

API documentation that lives in Confluence

API Docs Macros renders OpenAPI/Swagger specifications and JSON as clean, readable documentation right inside your Confluence pages — from a page attachment or pasted inline. Exports to PDF and Word. Your specs never leave Atlassian.

Built on Atlassian Forge · Runs on Atlassian (zero external servers)

The macros

📘 OpenAPI Viewer

Renders OpenAPI 3.x and Swagger 2.0 specs (JSON or YAML) as browsable API docs. Filter by tags, hide the info header or schema section — the page shows exactly what your readers need.

🌳 JSON Viewer

Displays any JSON as a collapsible tree with type colors and size badges. Choose how many levels start expanded, sort keys alphabetically, expand or collapse everything in one click.

📄 PDF & Word export

Both macros export with the page: OpenAPI specs become per-tag endpoint tables (method, path, summary, parameters); JSON becomes a code block. Most Confluence API macros export as a blank box — ours doesn't.

🔒 Zero egress

Everything renders inside Confluence. No external servers, no CDNs, no spec ever transmitted outside Atlassian — the app qualifies for the "Runs on Atlassian" program.

How to use

Insert a macro

  1. Edit a Confluence page and type /openapi or /json.
  2. Select OpenAPI Viewer or JSON Viewer.
  3. Click the macro, then the pencil icon to open its configuration.

Choose the source

  • Page attachment — attach your .json or .yaml file to the page (drag & drop while editing) and pick it in the macro configuration. Update the attachment and the macro follows.
  • Paste inline — paste the spec or JSON directly into the configuration textarea. Handy for snippets and examples.

Display options

  • OpenAPI Viewer: filter endpoints by tags (unused schemas are pruned automatically), hide the info header, hide the schemas section, set default expansion.
  • JSON Viewer: initial expanded depth, sort keys A→Z, expand/collapse all buttons on the rendered tree.
  • Both macros speak English and Español, following each viewer's Confluence language.

Export to PDF or Word

Use Confluence's normal export — no extra steps. The OpenAPI Viewer renders endpoint tables per tag honouring your tag filter; the JSON Viewer renders a code block. If a spec can't be exported (for example, it exceeds the export size cap), the export shows a clear message instead of a blank box.

Data & privacy

Your specifications never leave your Atlassian site. The app requests read access to pages and attachments only, renders entirely inside the Confluence page, stores its configuration in the macro itself, and makes zero external network calls. Questions? support@corventia.com.