- API Components
- Parameter Types
API Components
Parameter Types
Set path, query, and body parameters
All ParamField components are added as interactive elements in the API playground. See the demo for an example.
user_id
string
The id of the user
filterRequired
string
The filtering command used to sort through the users
user_ageDefault: 0
integer
The age of the user. Cannot be less than 0
<ParamField path="user_id" type="string">
The id of the user
</ParamField>
Props
| Name | Type | Description |
|---|---|---|
query, path, body, header | string | Whether it is a query, path, body, or header parameter followed by the name |
type | string | Expected type of the parameter’s value |
required | boolean | Indicate whether the parameter is required |
optional | boolean | Indicate whether the parameter is optional |
default | string | Default value |
placeholder | string | Placeholder value for the input in the playground |
children | string | Description of the parameter (markdown enabled) |
<ParamField path="user_id" type="string">
The id of the user
</ParamField>