Components

API Reference

Document API endpoints with request/response parameters

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

Example

<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.

ApiParams

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

ApiParam

One parameter or field.

ApiResponse

Response block with status code.

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