Open API (Swagger) for Confluence
Open API (Swagger) for Confluence
Breadcrumbs

Open API (Swagger) for Confluence

Build interactive API documentations hub in Confluence using OpenAPI specifications and Swagger UI.

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 OpenAPI Spec

There are two sources to configure OpenAPI in Confluence:

  1. Write or paste OpenAPI specifications directly in app using app editor

  2. Publish OpenAPI specifications from Bitbucket

The second option is recommended as it will automatically sync the specifications from Bitbucket and will always be up-to-date.

Using App Editor:

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

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

    • Left: Write or 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

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