<ResponseField> 组件来定义 API 的返回值。在需要列出某些对象的类型时，许多文档页面也会使用 <ResponseField>。
string
必填
响应字段示例
属性
string
必填
响应值的名称。
string
必填
响应值的预期类型——可以是任意字符串。
string
默认值。
boolean
在字段名旁显示“required”。
boolean
指示你是否已废弃该字段。
string[]
出现在字段名之前的标签
string[]
出现在字段名之后的标签
组件
响应字段
使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。
<ResponseField name="response" type="string" required>
响应字段示例
</ResponseField>
使用
⌘I
<ResponseField name="response" type="string" required>
响应字段示例
</ResponseField>