Parameter Fields

Set path, query, and body parameters

ParamField components define parameters for APIs or SDKs and automatically add an API Playground.

Props

query, path, body, or header

string

Parameter type and name

type

string

Expected value type

required

boolean

Whether parameter is required

deprecated

boolean

Whether parameter is deprecated

default

string

Default server value if none provided

initialValue

any

Playground initialization value

placeholder

string

Input placeholder text

children

string

Parameter description (markdown enabled)