Skip to main content

Swagger and Redoc

Rocket comes with first-class support for OpenAPI. It also provides its own hosted Swagger, Redoc, and Scaler for accessing the APIs. Follow the steps below to access API documentation.

  1. Navigate to Your Database: Log in to your Rocket account and select the desired database from the database selector located at the top left corner of the interface.

  2. Access API Page: On the left navigation menu, click on the "API" link to access the Data page.

  3. Click OpenAPI: On the top right corner of the page, click on the OpenAPI button.

  4. Select Documentation Tool: Click on Swagger, Redoc, or Scaler. This will open a new tab with the API documentation.

By following these steps, you can seamlessly access API documentation.