Parameter Fields

Set path, query, and body parameters

ParamField components help define the parameters for your APIs or SDKs. Adding a ParamField will automatically add an API Playground.

param · string · required

An example of a parameter field

Path Example

<ParamField path="param" type="string">
  An example of a parameter field
</ParamField>

Props

query, path, body, or 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

Supports number, string, bool, object.

Arrays can be defined using the [] suffix. For example string[].

required · boolean

Indicate whether the parameter is required

deprecated · boolean

Indicate whether the parameter is deprecated

default · string

Default value used by the server if the request does not provide a value

initialValue · any

Value that will be used to initialize the playground

placeholder · string

Placeholder text for the input in the playground

children · string

Description of the parameter (markdown enabled)