This add-on is un-official. The developer of this add-on is not an Apiary employee or related with Apiary in any other way.

Although this plugin free, Apiary itself has paid pro features, like team collaboration and private API's. You can use this add-on independently from your subscription level with Apiary. This is a very small add-on, actual work is done by Apiary and this add-on is free and will be free.

This is a Connect add-on that enables you to display Apiary API Documents inside a Confluence Page. To display you API, you have to first create it on apiary.io and add it to confluence page using Apiary macro.

Open Macro Browser
Click on Development section
Select Apiary Documentation

Macro Editor will be opened. There are several configuration items and nearly all of them has suitable default values.

Subdomain of API on Apiary: This is a required attribute and identifier of which document will be displayed. It is subdomain api as defined on Apiary. If you haven't yet created any document yourself, you can enter 'worklogpro' to test the add-on.

Max height in pixels to occupy inside Confluence page: If document size is taller than this height, you will need to scroll to see all of the document. If document is shorter white space will appear.

Collapse machine column by default: API details are hidden until an API method is selected.

Flexible width of 'Human Column': If not selected API description section is narrow and does not occupy the full page width, even if machine column is hidden.

After selecting Save, your API will be displayed inside confluence page. Note that you can add any other Confluence content above or below the API. Functionality of the document is the same as if it is displayed Apiary.

Privacy Policy

This add-on does not store any data itself either on Confluence or o any external server. All documents are stored inside Apiary and directly embedded into Confluence using Apiary embedding API.

Browser not supported