API Spec

General section sets the API's unique signature, including its URL path and the HTTP method that defines its action. You also configure required HTTP headers here, which are essential for aspects like authentication and content type.

This section lets you define URL parameters, including dynamic Path variables and optional Query strings for filtering. The system then automatically generates a code model from your query params for developers.

Request Body section is where you define the data payload sent to the API using a visual JSON editor. From this definition, the system generates consistent, ready-to-use code models for both your frontend and backend.

Response Body section defines the structure of the data payload the API returns after a request is processed. Like the Request Body, it uses a JSON definition to generate code models, making the response easy for the client to use.