Open API Documentation for Confluence

Name: Open API Documentation for Confluence
Rating: 2.8888888359069824 (18 reviews)

by O'Hara Group

works with Confluence Cloud, Confluence Server 6.0.1 - 9.2.0, Confluence Data Center 6.0.1 - 9.2.0 and more

OVERALL RATINGS
INSTALLS: 2,155
SUPPORT: Partner Supported
TRUST SIGNALS

Overview

Reviews

Pricing

Privacy & Security

Support

Installation

Key highlights of the appGenerate beautiful documentation for your Open API (Swagger) compliant JSON or YAML definitions

watch Open API Documentation for Confluence video

Generate beautiful API documentation

From your Open API-compliant JSON or YAML, generate beautiful, interactive documentation in your Confluence pages.

Embed or link to JSON or YAML definitions

Paste your Open API-compliant JSON or YAML definition directly into the macro body, or fetch it from a URL.

Consume and interact

Use the interactive Try It Out! mode to test API operations directly from within Confluence. View the response body, status code and headers; or copy and paste the generated Curl command for later.

More details

For Confluence administrators:

advanced configuration options are accessed via the 'Configure' button on the Manage Add-Ons page
you can control the allowed sources of JSON/YAML API definitions, such as "Only via a URL", "Only in the macro body", or "Both URL and macro body"
for URL sources, you can whitelist a set of allowed hosts or domains

Why choose us?

beware of imitations! Due to the popularity of our app, it is common for cheaper, inferior clones to appear from time to time in the Marketplace (sometimes directly copied from us). When choosing a vendor, please consider:
our app has been in the marketplace since June 2016, and we are proud to have earned 2375+ active installs
our app is regularly updated (typically weekly). See our version history
our app supports Data Center, Server and Cloud platforms
our developers regularly contribute back to the open source Swagger UI project that forms the core of the app
our support team are quick to respond to any issues. See our reviews

Resources

Descriptor
Get the descriptor file downloaded to your system
App documentation
Comprehensive set of documentation from the partner on how this app works
EULA
Get the End User License Agreement for this app

Privacy and Security

Privacy policy

Atlassian's privacy policy is not applicable to the use of this app. Please refer to the privacy policy provided by this app's partner.

Partner privacy policy

Security program

This app is part of the Marketplace Bug Bounty program.

About Bug Bounty program

Integration permissions

Open API Documentation for Confluence integrates with your Atlassian product

Version information

Version 1.3.4-AC•for Confluence Cloud

Release date: Sep 26th 2023
Summary: See release notes
Details: ⚠️ Please note:

Updates and improvements to the Cloud version are released continuously (typically weekly), and these updates will not appear here as new versions of the app.

Current Swagger UI version (as at 26 November 2024):

v5.18.2

What's new in version 1.3.4:

Confluence dark mode is now officially supported
Warn when a large (over 1Mb) API specification is supplied in the macro body, as this can negatively impact end-user experience. We recommend using a URL for large API specifications.

Browser/Open API spec support:

Supports Open API spec 3.1, 3.0 and 2.0 (older 1.0/1.1 specs no longer supported)
Works in latest Chrome, Safari, Firefox and Edge
Payment model: Paid via Atlassian
License type: Commercial