Available on the Atlassian Marketplace

API documentation that lives in Confluence

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

Get it on the Atlassian Marketplace

30-day free trial · Built on Atlassian Forge · Runs on Atlassian (zero external servers) · Light and dark mode

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, and copy any endpoint as a ready-to-paste cURL command — the page shows exactly what your readers need.

📝 Markdown Viewer

Renders a Markdown file from the page attachments (your repo's README, say) or pasted text: headings, lists, task lists, tables, code blocks and links. Images that point to page attachments render inline.

🌳 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

All three macros export with the page: OpenAPI specs become per-tag endpoint tables (method, path, summary, parameters); Markdown becomes native headings, lists, tables and code; JSON becomes a code block. Most Confluence API macros export as a blank box — ours don't.

🔒 Zero egress

Everything renders inside Confluence. No external servers, no CDNs, no file ever transmitted outside Atlassian — the app carries the "Runs on Atlassian" badge.

🌙 Light and dark

Every macro follows the viewer's Confluence theme, including the OpenAPI reference. English and Español UI, picked from each viewer's Confluence language.

How to use

Insert a macro

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

Choose the source

  • Page attachment — attach your .json, .yaml or .md 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, Markdown 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, search endpoints by tag, path or summary. Every expanded endpoint offers Copy as cURL — a command built from the spec alone (server, parameters, auth scheme, sample body; unknowns stay as placeholders) — and a Copy path button.
  • Markdown Viewer: GitHub-style task lists, tables and fenced code; raw HTML is escaped; relative image paths resolve to page attachments, external images show their alt text (nothing is fetched from outside).
  • JSON Viewer: initial expanded depth, sort keys A→Z, expand/collapse all buttons on the rendered tree.
  • All three macros speak English and Español, following each viewer's Confluence language, and switch with the Confluence theme.

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 Markdown Viewer renders native headings, lists, tables and code blocks; the JSON Viewer renders a code block. If a document 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 files 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.