ParamField components help define the parameters for your APIs or SDKs. Adding a ParamField will automatically add an API Playground.
string
required
An example of a parameter field
Props
string
Whether it is a query, path, body, or header parameter followed by the name
string
Expected type of the parameter’s value
boolean
Indicate whether the parameter is required
boolean
Indicate whether the parameter is deprecated
string
Default value used by the server if the request does not provide a value
any
Value that will be used to initialize the playground
string
Placeholder text for the input in the playground
string
Description of the parameter (markdown enabled)