Skip to main content
Stoplight Elements for Confluence is a Forge app with two macros that render API documentation directly inside a Confluence page: a Stoplight Elements macro for any OpenAPI document, and a Stoplight Elements Dev Portal macro for a project hosted on Stoplight’s platform.

​
Who this is for

API teams who keep an OpenAPI document — reachable over HTTP, or pasted directly into the macro — and want a readable, three-panel reference (endpoints, schemas, and a Try It console) inside Confluence instead of a link out to another tool. Teams already on a paid Stoplight.io plan can instead embed their full hosted dev portal.

​
Prerequisites

  • A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn’t support Data Center)
  • For the Stoplight Elements macro: an OpenAPI 2.0, 3.0, or 3.1 document, as a URL or pasted YAML/JSON
  • For the Stoplight Elements Dev Portal macro: a project ID from a paid Stoplight.io plan

​
Get started

1

Install

See Installation for how to add Stoplight Elements for Confluence from the Atlassian Marketplace.
2

Add it to a page

See Usage for how to insert and set up the macro.
3

Configure

See Configuration for the full reference of every field.
Need help? Visit the Stoplight Elements for Confluence service desk portal.