字段
使用 ParamField 和 ResponseField 组件，通过类型、默认值和验证规则为 API 请求和响应参数编写文档。
使用字段为 API 的参数与响应编写文档。字段分为两类：参数字段和响应字段。
使用 <ParamField> 组件为你的 API 或 SDK 定义参数。添加一个 ParamField 将自动添加一个 API 操作台。
paramstringrequired参数字段示例
<ParamField path="param" type="string" required>
参数字段示例
</ParamField>query, path, body, or headerstring指定参数属于 query、path、body 或 header，后面跟随 参数名称。
typestring参数值的预期类型。
支持 number、string、boolean、object。
使用 [] 后缀定义数组，例如 string[]。
requiredboolean指明你是否要求该参数。
deprecatedboolean指明你是否已废弃该参数。
defaultany当请求的值为空时将使用的默认值。
placeholderstringplayground 中输入框的占位文本。
childrenstring参数说明（支持 Markdown）。
<ResponseField> 组件用于定义 API 的返回值。
responsestringrequired响应字段示例
<ResponseField name="response" type="string" required>
响应字段示例
</ResponseField>namestringrequired响应值的名称。
typestringrequired响应值的期望类型。可以是任意字符串。
defaultstring默认值。
requiredboolean指示你是否要求该响应。
deprecatedboolean指示你是否已废弃该字段。
prestring[]出现在字段名称之前的标签。
poststring[]出现在字段名称之后的标签。
Was this page helpful?Suggest editsRaise issue