Insert the Swagger for Confluence macro into your Confluence page.

Select the source of the OpenAPI specification.

You can specify an URL or select an attachment. Swagger for Confluence supports .yaml and .json file extensions.

You can modify the view by:

• Setting the number of maximum tags displayed

• Defining how the specification will be expanded when rendered on the page by choosing: nothing, tags only, tags and operators

• You may also select how operations should be ordered : default, by paths alphanumerically or by HTTP method

Select HTTP methods you want to enable for Try it out function: GET, PUT, POST, DELETE, OPTIONS, HEAD, PATCH, TRACE. You can also select ALL to enable all methods.

You may also select how models will be rendered : default, example, model.

Display options allow you to show hidden by default parts of the specification:

• Id of the operation

• Duration of the Try it out request

• Vendor extensions

• Common extensions

Publish and enjoy interactive Open API documentation on your Confluence page!

You can now share your page externally with External Share for Confluence.

This macro works flawlessly on shared pages! Try it out!