# Swagger/OpenAPI macro

📝

Get started with showcasing API endpoints with the Swagger/OpenAPI Macro.

| **Description**   | Display an OpenAPI schema for a REST API on your Confluence page. |
| ----------------- | ----------------------------------------------------------------- |
| **Type**          | Standard                                                          |
| **Guest**         | SUPPORTED                                                         |
| **Anonymous**     | Partial                                                           |
| **Capable Sites** | SUPPORTED                                                         |

Welcome to our guide on using the Swagger/OpenAPI Macro in Confluence. This powerful tool is designed to help you seamlessly integrate and display API documentation directly within your Confluence pages.

Whether you're documenting a new API or integrating existing API specifications into your project documentation, the Swagger/OpenAPI Macro makes it easy to visualize and interact with API endpoints.

* **Interactive Documentation**: Present your API documentation in an interactive format that allows users to explore endpoints, try out API calls, and see responses in real time.
* **Easy Integration**: Embed your Swagger or OpenAPI files directly into Confluence, ensuring that your documentation is centralized and accessible to your team.
* **Real-Time Updates**: Any changes to your API specifications are automatically updated in the documentation displayed in Confluence, keeping your project stakeholders informed with the latest data.

![Swagger API macro](https://help.gocapable.com/images/a2c94bfd-3c94-4b7b-84c3-a69f8923f60c.webp)

## 1\. Open the editor and type `/swagger` and press Enter

![Insert Capable Swagger Macro](https://help.gocapable.com/images/ff415853-3de7-40e0-ae37-3b632642ff6b.webp)

## 2\. Choose the source of the documentation

![Swagger API macro configuration](https://help.gocapable.com/images/055895b9-5470-4489-a461-5b21c251b2ac.webp)

## 3\. Click Save and you’re done!

![Swagger macro in Confluence](https://help.gocapable.com/images/b4f1b5a2-a437-4e47-8899-f474ef052436.webp)

## Example

Loading API documentation…