/
Open API (Swagger) for Confluence

Open API (Swagger) for Confluence

Install

You can install the app from Atlassian Marketplace: Open API (Swagger) for Confluence FREE

User Guide

  1. Open a Confluence page in edit mode

  2. Type /openapi or click + → OpenAPI - Swagger UI

  3. The macro will appear with a "Configuration Required" message

Configuring Your API Spec

  1. Click the pencil icon on the macro to open the configuration panel

  2. You'll see a split-pane editor:

    • Left: Paste your OpenAPI/Swagger specification (JSON or YAML)

    • Right: Live preview of your API documentation

  3. Click Load Sample to see an example spec

  4. Once your spec looks correct in the preview, click Save

Screenshot 2025-11-26 at 23.51.12.png
Open API edit and preview example in Confluence

 

Supported Formats

Format

Example Start

Format

Example Start

YAML

openapi: 3.0.0

JSON

{"openapi": "3.0.0"

The editor auto-detects your format — no configuration needed.

Tips

  • Get your spec: Export from tools like Swagger Editor, Postman, or your API framework

  • Large specs: The macro handles full OpenAPI 3.x and Swagger 2.0 specifications

  • Multiple APIs: Add multiple macros to document different services on one page