Customers have installed this add-on in at least 160 active instances.
Free add-on

Render API specifications in pretty Confluence format

Render API specifications in pretty Confluence format

Supports multiple RAML sources

RAML in pretty Confluence format

Edit the RAML inline

Upload your RAML file or specify a public URL

Rrender the RAML in pretty Confluence format with build in support for rendering markdown in the RAML and code blocks for JSON Schemas and examples

Collaborate on the API design and edit the RAML spec inline as your API evolves

More details

A macro to render an uploaded or publicly hosted RAML file in pretty Confluence format. It has built in support for rendering markdown in the RAML file and code blocks for JSON schemas and examples. The uploaded RAML can be edited in place as users collaborate on the API design.

User reviews

Sign in to write a review
by Jonathan Stearnes x:4507 c:210 319-4507 on 2017-07-07
Hi, we're getting the following message when trying to save RAML content: Macro Body not available, please save the page. Can you help?
Was this review helpful?YesNo
by Jarosław Śmiejczak on 2017-06-21
Do you plan to support RAML 1.0? Can you give us an ETA? Our client prefers to keep documents in that version, downgrade to 0.8 isn't a preferred solution.
Was this review helpful?YesNo
by Anthony Daga on 2017-04-29
Hi, As of July 2016, you mention that RAML 1.0 support coming soon. I only see the 0.8 option when creating a page in confluence. Any news on this? Thanks, Anthony FYI: I need to share our API docs (written in RAML 1.0) with team and clients. I'd prefer for them to go to confluence where I can make changes quickly as needed.
1 out of 1 found this review helpful
Was this review helpful?YesNo
by Arnaud Quette on 2017-02-07
Hi, just a heads-up to try to get an answer, and potentially a timeframe, on the availability of the Enterprise version. I'm still using the workaround (raml2html + publication on a staging internal website + HTML inclusion on Confluence using iframe), but that's far from ideal for pushing RAML as an internal standard. Thanks in advance for answering, and cheers
Was this review helpful?YesNo
by Anubhav Sharma on 2016-11-30
Hi, Tried adding the macro in confluence but nothing happens. I added a .RAML file using choose file and there is no action taken on the screen. Getting a Uncaught ReferenceError - AP is not defined Do you know what I need to do to make this work.
Was this review helpful?YesNo
Atlassian Labs

Hi Anubhav,

Sorry for such a late response. Are you still facing the issue?



Support is not available for this add-on.

Vendor support resources

See existing Q&A in Atlassian CommunityAsk a question in the Atlassian Community

Atlassian-hosted discussions connect you to other customers who use this add-on.


Confluence Cloud Released 2017-07-13


Minor version update


Minor version update


  1. Log into your Confluence instance as an admin.
  2. Click the admin dropdown and choose Add-ons. The Find new add-ons screen loads.
  3. Locate Render API Docs Macro.
  4. Click Install to download and install your add-on.
  5. You're all set! Click Close in the Installed and ready to go dialog.

Similar add-ons