Skip to main content
Apiary Embed for Confluence is a Forge app with two macros — Apiary Embed (raw code) and Apiary Embed (generate code) — that render an Apiary API Project as interactive API documentation, with a human-readable column, a machine column, and a request console, directly inside a Confluence page.

​
Who this is for

Teams who document their API in an Apiary API Project and want that documentation visible to the rest of the org in Confluence, instead of linking out to Apiary.

​
Prerequisites

  • A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn’t support Data Center)
  • An Apiary API Project, and either its subdomain or the raw embed script Apiary generates for it

​
Get started

1

Install

See Installation for how to add Apiary Embed for Confluence from the Atlassian Marketplace.
2

Add it to a page

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

Configure

See Configuration for the full reference of every field on both macros.
Need help? Visit the Apiary Embed for Confluence service desk portal.