Swagger (OpenAPI Documentation)
Last updated
Xano Documentation
Last updated
Quick Summary
Swagger documentation provides a standardized way to describe and visualize APIs, showing what requests they accept and what responses they return - like a detailed menu that shows all available options. It allows developers to understand, test, and integrate with APIs without needing to read through pages of technical documentation.
Xano automatically generates documentation for your APIs using Swagger, which provides the information in a standardized format called OpenAPI. The documentation contains information like the API name, description, inputs, and expected response.
Using these standardized methods allows for easy import of your API information into other platforms, such as your frontend of choice, as well as AI chatbots and large-language models for development assistance. In addition, it provides you an easy way to send API specifications to other developers you might be working with, without giving them access to the rest of your Xano workspace.
Please note that customized response structures may not be accurately displayed in your Swagger documentation. You can still use Swagger to its full extent in spite of this.
Documentation is generated for each API group. At the top of the API group page, just click to access the auto-generated documentation for that group.
You can review the response given below.
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 other external platforms that rely on this type of standardized information about your APIs or providing to AI chatbots / LLMs.
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.
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.
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.
