Auto-Documentation

Xano uses Swagger to automagically document your API!

Every API Endpoint in Xano is Auto-documented

Xano automatically documents all your API endpoints in Swagger. This way, you can pass the document to any front-end engineer or stakeholder that might want to see your API without giving them access to your Xano workspace.

Within the Swagger documentation, you will be able to test and try out your API endpoints to see if they work the way that you expect them to.

Let's open the POST /lesson API and see what it looks like.

After clicking "Try it out" we can click on the "Execute" button, which will use the API to generate a new lesson record.

Swagger will show any errors that can come up when running an API.

API Spec

Swagger also provides you with an API specification URL. Select this from the top of your API documentation to open up the API specification. This can often be helpful for getting a broad understanding of how your API works and how different endpoints interact and relate.

Select the API spec link to see the API specification.

API Spec in JSON

By default, the API Spec is in a YAML format. However, JSON format is supported. In order to view the API Spec in JSON, append ?type=json to the spec URL.

Append ?type=json to see your API Spec in JSON format.

Disabling Swagger Documents

You are able to disable Swagger documentation on an API group level. To enable or disable the documentation head to an API groups settings.

Enabling Private Swagger Access

You have the ability to not only enable or disable Swagger documentation, but also enable it via a tokenized link. This means that you can still share documentation with interested parties, but have more control over who can have and maintain access to this.

To revoke your tokenized link and generate a new one, just click the Reset Token button immediately below the dropdown.