跳转到主要内容
<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>
<ResponseField> 组件用于定义 API 的返回值。在需要列出某些事物的类型时,许多文档页面也会使用 <ResponseField>
response
string
required
响应字段示例
<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>

Props

name
string
required
响应值的名称。
type
string
required
响应值的预期类型——可以是任意字符串。
default
string
默认值。
required
boolean
在字段名称旁显示“required”。
deprecated
boolean
该字段是否已废弃。
pre
string[]
显示在字段名称之前的标签
post
string[]
显示在字段名称之后的标签
<ResponseField name="response" type="string" required>
  响应字段示例
</ResponseField>
I