跳转到主要内容
使用字段来记录 API 的参数与响应。字段分为两类：参数字段和响应字段。

​
参数字段

<ParamField> 组件用于为你的 API 或 SDK 定义参数。添加 ParamField 后会自动生成一个 API交互测试台。
​
param
string
required
参数字段示例
<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
在 API 交互测试台中输入框的占位文本。
​
children
string
参数描述（支持 Markdown）。

​
响应字段

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

​
属性

​
name
string
required
响应值的名称。
​
type
string
required
响应值的预期类型。可以是任意字符串。
​
default
string
默认值。
​
required
boolean
指示是否必需该响应。
​
deprecated
boolean
该字段是否已弃用。
​
pre
string[]
显示在字段名之前的标签。
​
post
string[]
显示在字段名之后的标签。