响应字段

<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>

<ResponseField> 组件用于定义 API 的返回值。在需要列出某些对象的类型时，许多文档页面也会使用 <ResponseField>。

string

必填

响应字段示例

<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>

属性

string

必填

响应值的名称。

string

必填

响应值的预期类型——可以是任意字符串。

string

默认值。

boolean

在字段名旁显示“required”。

boolean

指示该字段是否为已废弃。

string[]

显示在字段名之前的标签

string[]

显示在字段名之后的标签

<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>