Swagger UI

2 minutes to read

Swagger UI is a popular third-party tool for developers to effortlessly interact and test against Caspio’s REST API using a visual interface. You can use the Swagger UI to try out with the API before you start customizing your application.

To access Swagger UI documentation, use the Documentation URL available in your Web services profile. The Documentation URL is based on your Integration URL:
https://<your-integrations-url>/integrations/rest/swagger

To see our Swagger UI documentation without testing, go to https://demo.caspio.com/integrations/rest/swagger.

By default, the links open Swagger UI with the latest REST API version preselected. To view a previous version, use the Select API version dropdown at the top of the Swagger UI interface.

Caspio REST API operations are categorized according to Caspio objects.

Clicking on an object name to expand the section to view all available operations for the selected object.
Click on an operation to view parameters, criteria, sample responses, response codes, and models with descriptions of possible values.

Authenticate in Swagger UI

Open your Swagger UI URL in a browser: https://{your-integration-url}/integrations/rest/swagger
In the version dropdown, select the API version you want to test.
Select Authorize in the top-right corner.
Enter your bearer token in the Value field in the format Bearer {your_token}.
Select Authorize, then select Close.

If you do not have a bearer token yet, open your API profile, select the Credentials tab, and select Generate bearer token.

Make a test call

Swagger UI makes real API calls. Requests you execute create, modify, or delete actual objects and data in your Caspio account. For testing, work against a copy of one of your tables or a dedicated test table, so you do not alter live data.

Expand a resource group to see its endpoints.
Select an endpoint to expand its detail panel.
Select Try it out.
Fill in any required parameters.
Select Execute.
Review the response in the Responses section below the form.

AI-Readable API Specification

To facilitate AI processing of Caspio’s REST API specification, use the documentation available here:

v4: https://demo.caspio.com/integrations/rest/v4/swagger/documentation
v3: https://demo.caspio.com/integrations/rest/v3/swagger/documentation