OpenAPI Viewer for Confluence
Show OpenAPI 3.x and Swagger 2.0 specs as readable API documentation on any Confluence page, from an attachment or pasted.
Show an OpenAPI or Swagger spec on a Confluence page, from an attached file or pasted text: endpoints by tag, parameters, request bodies, responses and schemas, with references resolved. Runs entirely on Atlassian.
What it does
- OpenAPI 3.0 and 3.1, Swagger 2.0; YAML and JSON
- Endpoints grouped by tag, expandable one by one or all at once
- Parameters, request bodies, responses, examples
- Schemas as collapsible trees, references resolved
- Light and dark theme
Where it appears
- Macro in the Confluence editor: type /OpenAPI and choose OpenAPI & Swagger viewer.
How to use it
- Attach your spec (for example openapi.yaml) to the page, or keep it ready to paste.
- In the editor, type /OpenAPI and choose the macro. The settings dialog opens.
- Choose the attached file, or switch to Paste and paste the spec. Optionally show schemas and expand all endpoints.
- Save and publish the page.
- To update the docs, upload a new version of the attachment with the same name.
Permissions
The app runs on Atlassian’s Forge platform and declares no permission to contact outside servers. It asks for these scopes:
| Scope | Why |
|---|---|
| read:attachment:confluence | Read the spec file attached to the page. |
| read:page:confluence | Find the attachments of the page, and check that a reader can see the page a pasted spec belongs to. |
| read:blogpost:confluence | The same for blog posts. |
| read:confluence-content.permission | Allow only people who can edit the page to save or replace a pasted spec. |
| storage:app | Keep pasted specs in the app's storage on Atlassian's platform. |
Data and privacy
- What the app stores
- Pasted spec text, with the id of the page it was pasted on and the save time, and a per-page count of saves in the current hour. Attached specs are not copied.
- Personal data
- None. No names, e-mail addresses or account ids are stored.
- Logs
- Error messages only, without page content.
- Where it lives
- In the app’s storage on Atlassian’s Forge platform, in the same data residency location as your Atlassian site. Nothing is copied to servers outside Atlassian. When the app is uninstalled, Atlassian deletes its storage under Atlassian’s data retention policy.
Details for all apps are in the privacy policy.
Good to know
- References to other files (external $ref) are shown unresolved.
- Very large specs (several megabytes) take a few seconds to render.
Questions
No. Attached specs are read in the browser; pasted specs are stored in the app’s storage on Atlassian’s platform. The app has no permission to contact any outside server.
No. The viewer is for reading; it sends no requests to your API.
Attached specs move with the page. A pasted spec keeps working on the copy for people who can see the original page.