跳转到主要内容
使用字段为 API 的参数与响应编写文档。字段分为两类：参数字段和响应字段。

​
参数字段

使用 <ParamField> 组件为你的 API 或 SDK 定义参数。添加一个 ParamField 将自动添加一个 API 操作台。
​
param
string
必填
参数字段示例
<ParamField path="param" type="string" required>
  参数字段示例
</ParamField>

​
属性

​
query, path, body, or header
string
指定参数属于 query、path、body 或 header，后面跟随 参数名称。
​
type
string
参数值的预期类型。支持 number、string、boolean、object。使用 [] 后缀定义数组，例如 string[]。
​
required
boolean
指明你是否要求该参数。
​
deprecated
boolean
指明你是否已废弃该参数。
​
default
any
当请求的值为空时将使用的默认值。
​
placeholder
string
playground 中输入框的占位文本。
​
children
string
参数说明（支持 Markdown）。

​
响应字段

<ResponseField> 组件用于定义 API 的返回值。
​
response
string
必填
响应字段示例
<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>

​
属性

​
name
string
必填
响应值的名称。
​
type
string
必填
响应值的期望类型。可以是任意字符串。
​
default
string
默认值。
​
required
boolean
指示你是否要求该响应。
​
deprecated
boolean
指示你是否已废弃该字段。
​
pre
string[]
出现在字段名称之前的标签。
​
post
string[]
出现在字段名称之后的标签。