Skip to main content
Xano automatically generates Swagger/OpenAPI documentation for your APIs, making it easy to share your endpoints with frontend developers, AI app builders, AI coding assistants, or third-party services. It’s also a quick way to visualize and test your API endpoints. The API documentation is accessible at the workspace level (combined — all API groups in one spec), the group level (one spec per API group), or the individual API level. Each URL can be shared publicly, protected with a token, or disabled entirely.

​
Combined (Workspace Level) Documentation

This is the recommended approach. Combined documentation gives you a single URL and spec file covering all your selected API groups. This is the easiest way to share your full API surface with frontend tools, AI app builders, AI coding assistants, or anyone who needs to work with your APIs.

​
First Time Setup

From the API Groups page, click Swagger Documentation Disabled in the top right to access the settings. You’ll need to select which API groups you want to be made available in your workspace-level documentation. swagger-openapi-documentation-20251208-101351 At the bottom of the panel, select the desired option to enable the documentation (public or requires token), and use the check boxes to select which API groups to include. swagger-openapi-documentation-20251208-101457

​
Accessing the Documentation

Once first-time setup is complete, you can access the workspace-level Swagger/OpenAPI documentation by clicking Swagger Documentation in the top right of the API Groups page. swagger-openapi-documentation-20251208-101526 You can access a downloadable version of your OpenAPI specification in JSON format by selecting the link under the title of the page. This single JSON file is what you’ll share with AI builders, coding assistants, or frontend developers.

​
Group Level Documentation

If you need documentation for a single API group — for example, to share only a specific set of endpoints — you can access group-level documentation instead. From inside of an API group, click Swagger Documentation in the top right to access the Swagger/OpenAPI documentation for that specific group. swagger-openapi-documentation-20251208-100959 This will open a new tab with the Swagger UI, displaying all the endpoints in that API group, along with details about request parameters, responses, and authentication. swagger-openapi-documentation-20251208-101019 You can access a downloadable version of your OpenAPI specification in JSON format by selecting the link under the title of the page. swagger-openapi-documentation-20251208-101116

​
Documentation settings

From the API group settings, you can configure whether or not the Swagger documentation is enabled, and whether it requires a token to access. swagger-openapi-documentation-20251208-101219

​
API Level Documentation

You can also access Swagger/OpenAPI documentation for individual API endpoints. From inside an API, click the icon to view documentation specific to that endpoint. swagger-openapi-documentation-20251208-101625

​
Using the Documentation

1

Review the API information shown.

Each API will show you the method, the API name, and the description on the left side.
On the right, you’ll see a 🔓 icon if that API requires authentication.
Click the V to interact with your API of choice.
2

Sending Authenticated Requests

If any of the API(s) you want to interact with require authentication, click at the top of the page to supply an authentication token.
3

Click 'Try it out' to send a request to that API.

4

Fill in any request body values or parameters necessary.

5

Click 'Execute' to send the test request.

You can review the response given below.

​
Additional Features

​
Defining Sample Inputs and Responses

When testing your function stacks in Xano, you can define sample input and output examples for your Swagger documentation. It is important that you do this to ensure that your documentation is as effective as possible, as well as for helping AI models understand what’s expected when interacting with your APIs.
1

In the 'response' section of the Run panel, click Set As Example

2

Review the sample input and response, and make any necessary adjustments

Make sure these do not include any sensitive information.
3

Click Save and you will see these defined in your Swagger documentation.

If you need to make adjustments later, you can do so from the settings menu.

​
Copy / Copy as cURL

Throughout the documentation, you’ll see icons. These will let you quickly copy the contents of that element, and in the presence of a cURL command, copy that command to quickly paste into a terminal or other API / testing platform of choice, such as Postman.

​
JSON OpenAPI Spec

You can click the link at the top of the page to access a JSON-formatted version of your API spec. This is useful for AI app builders, AI coding assistants, and other external platforms that rely on standardized API specifications.