Documentation

Installation

As any app for Confluence Cloud, you can install the app via the Confluence admin menu.

  1. Log into your Confluence instance as an admin.

  2. Click on “Apps > Manage apps” in the header menu.

  3. Click on “Find new apps” on the right navigation.

  4. Search for “RapiDoc OpenAPI & Swagger Specification UI for Confluence” and select it.

  5. Click on “Try it free” to install the app.

Usage

RapiDoc OpenAPI & Swagger Specification UI for Confluence provides two macros that visualizes an OpenAPI specification on a Confluence page:

  • RapiDoc OpenAPI viewer (Remote): Adds a RapiDoc viewer based on a remote OpenAPI Specification

  • RapiDoc OpenAPI viewer (Inline): Adds a RapiDoc viewer based on an inline OpenAPI Specification

Macro “RapiDoc OpenAPI viewer (Remote)”

This macro allows you to load a OpenAPI specification from a remote URL.

Macro “RapiDoc OpenAPI viewer (Inline)”

This macro allows you to define an OpenAPI specification as JSON string.