Components

API Reference

Document API endpoints with request/response parameters

Use the API components to document REST endpoints: method, path, parameters, and responses.

Example

GET /api/users

Returns a list of users.

Query Parameters

limit number required

Maximum number of results (default: 10)

offset number

Number of results to skip

200 Success

Response body

users array

List of user objects

total number

Total count

<ApiEndpoint method="GET" path="/api/users" description="Returns a list of users.">
  <ApiParams title="Query Parameters">
    <ApiParam name="limit" type="number" required description="Max results (default: 10)" />
    <ApiParam name="offset" type="number" description="Skip N results" />
  </ApiParams>
  <ApiResponse status={200} description="Success">
    <ApiParams title="Response body">
      <ApiParam name="users" type="array" description="List of user objects" />
      <ApiParam name="total" type="number" description="Total count" />
    </ApiParams>
  </ApiResponse>
</ApiEndpoint>

Components

ApiEndpoint

Wraps a single endpoint. Shows HTTP method and path.

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'required

HTTP method

pathstringrequired

Path (e.g. /api/users)

descriptionstring

Short description

ApiParams

Container for a list of parameters (query, body, or response).

titlestring

Section title (e.g. “Query Parameters”, “Request body”)

ApiParam

One parameter or field.

namestringrequired

Parameter name

typestringrequired

Type (e.g. string, number, array, object)

requiredboolean

Mark as required

descriptionstring

Description

ApiResponse

Response block with status code.

statusnumberrequired

HTTP status (e.g. 200, 201, 400, 404)

descriptionstring

Short description

Use ApiParams and ApiParam inside ApiResponse to document the response body shape.