Atlassian Tools
Build interactive API documentation hub in Confluence with OpenAPI (Swagger) for Confluence
•
min read
OpenAPI (Swagger) for Confluence is a new Atlassian Marketplace app by Narva Software that turns any OpenAPI or Swagger spec into interactive API documentation on a Confluence Cloud page. You add a YAML or JSON file, and readers browse endpoints, schemas and examples without leaving Confluence.
Most teams keep the API reference in one place and everything else in another. The spec lives in Git or a hosted Swagger UI. Requirements, runbooks and release notes live in Confluence. Someone pastes the endpoint list into a page, the API changes, and the copy goes stale. Postman's 2024 State of the API Report found that 74% of respondents now work at API-first organizations, up from 66% in 2023. More APIs means more drift.
With this new app we're closing that gap. OpenAPI (Swagger) for Confluence by Narva Software puts your OpenAPI Confluence documentation on the pages your team already reads. Install it from the Atlassian Marketplace.
What OpenAPI (Swagger) for Confluence does
OpenAPI (Swagger) for Confluence renders a full, Swagger UI–style API reference inside a Confluence macro. Missing docs are a real cost: in Postman's 2023 State of the API Report, lack of documentation ranked as the top obstacle to consuming APIs.
Set Up an OpenAPI Documentation Hub in Confluence
Turn Confluence into a single home for API documentation, powered by OpenAPI specifications and Swagger UI. Your team can document, test and consume APIs in the same space where all your other knowledge lives.
Git Integration (GitHub and Bitbucket)
Does your team keep its API specifications in GitHub or Bitbucket and collaborate on them with Git? Connect our GitHub or Bitbucket integration to sync your repository and publish the latest OpenAPI spec to Confluence automatically.
Edit OpenAPI Specs Directly with the Built-In Swagger Editor
Make quick changes to your OpenAPI specifications without leaving Confluence, using the Swagger Editor that comes with the app. It works with both YAML and JSON.
Features of OpenAPI (Swagger) for Confluence
The new OpenAPI (Swagger) for Confluence by Narva Software brings your API documentation into the place your team already works. Write, preview and publish OpenAPI specs on any Confluence page, and keep them in sync with your Git repository. Here’s what’s included:
📝 JSON and YAML support: Write your spec in whichever format you prefer. The app detects the format automatically, so there’s nothing to configure.
👁️ Live preview: Watch your API documentation update as you type, with the editor and rendered docs side by side in a split-pane view.
🎨 Full Swagger UI: Give readers the interactive, industry-standard API reference they already know, right on the Confluence page.
📌 Git integration (GitHub and Bitbucket): Sync your OpenAPI spec from your repository and publish the latest version to Confluence automatically.
Get OpenAPI (Swagger) for Confluence free
Bring your API specs into Confluence today, connect GitHub or Bitbucket, and give your whole team one current, interactive API reference.
How to embed Swagger and OpenAPI specs in Confluence
To embed Swagger in Confluence, install OpenAPI (Swagger) for Confluence, insert its macro on a page, add your spec and publish. Speed matters here: Postman's 2024 report found that 63% of developers can produce an API within a week, so docs need a process just as fast.
Before you start, you need Confluence Cloud, a site admin to approve the install, and a Swagger 2.0 or OpenAPI 3.x spec in YAML or JSON.
Install the app: A Confluence site admin opens the Atlassian Marketplace listing and starts the free trial.
Open a page: Create a new Confluence page or open an existing page in edit mode.
Insert the macro: Type /OpenAPI in the editor and select OpenAPI (Swagger) for Confluence.
Add your spec: Paste YAML or JSON, upload a .yaml, .yml or .json file, or enter the URL of a hosted spec.
Publish: Click Publish, and Confluence shows the spec as interactive API docs to everyone who can view the page.
Who OpenAPI (Swagger) for Confluence is for
OpenAPI (Swagger) for Confluence serves any team that writes, reviews or supports an API and already plans its work in Confluence. Postman's 2024 report found that inconsistent documentation is a leading roadblock for API consumers, so every team in the table below gains from one rendered source.
Team | Scenario | What changes |
API-first product teams | Specs drive design reviews and sprint planning | The spec sits beside the requirements page it implements |
Platform teams | Internal APIs serve dozens of consuming teams | One Confluence space becomes the internal API catalog |
Technical writers | Reference docs and guides live in different tools | Tutorials and the API reference share one page tree |
Partner and integration teams | External partners need a clear contract | Partners read a current spec in a shared space |
QA and support | Testers and agents check expected responses | They read and test endpoints without asking a developer |
Frequently asked questions
How do I display a Swagger or OpenAPI file in Confluence?
Install OpenAPI (Swagger) for Confluence from the Atlassian Marketplace. Open a Confluence page in edit mode, type /OpenAPI and insert the macro. Then paste your spec, upload a YAML or JSON file, or enter a spec URL. Publish the page, and Confluence renders the spec as interactive API documentation.
Does OpenAPI (Swagger) for Confluence support OpenAPI 3.0 and Swagger 2.0?
Yes. OpenAPI (Swagger) for Confluence renders Swagger 2.0 and OpenAPI 3.x specifications, including OpenAPI 3.0 and 3.1, in YAML or JSON. You do not need to convert older Swagger 2.0 files first. The app reads the version field in your spec and displays the API reference to match.
Can I import a YAML or JSON spec from a URL or Git repository?
Yes. Point the macro at any spec URL the reader's browser can reach, such as a raw file link from GitHub, GitLab or Bitbucket, or the spec endpoint of your API gateway. The page loads the current file each time it opens, so the docs update when the source file changes.
Does it work on Confluence Cloud, Data Center or Server?
OpenAPI (Swagger) for Confluence is built for Confluence Cloud and installs from the Atlassian Marketplace. Atlassian ended support for its Server products on February 15, 2024, so there is no Server version. Data Center teams should check the Marketplace listing for current hosting options before planning a rollout.
Can readers test API endpoints from the Confluence page?
Yes. Readers expand an endpoint, fill in parameters and send a live request with the Try it out button. The response code, headers and body appear right on the page. Your API must allow cross-origin requests (CORS) from the browser, and each reader supplies their own credentials.
Is there a free trial?
Yes. OpenAPI (Swagger) for Confluence includes a 30-day free trial, the standard for paid Confluence Cloud apps on the Atlassian Marketplace. A Confluence site admin starts the trial from the Marketplace listing. After the trial, pricing follows the per-user tiers shown on the listing.
Nar is the founder of Narva Software and a former software developer with real-world experience using Atlassian tools. After facing the limitations of Jira and Confluence himself, he set out to build simple, effective apps that make teamwork easier. Today, his focus is on creating practical solutions that help teams work faster and smarter — and are trusted by companies around the world.
