可展开项

使用可展开组件在 API 文档中切换嵌套对象属性的显示，展示请求和响应对象的子字段。

使用可展开项在响应字段中显示或隐藏嵌套内容。它们对在 API 文档中展示复杂对象属性尤其有用。

user · User Object

显示 properties

full_name · string

用户的全名

is_over_21 · boolean

用户是否已满 21 岁

Expandable example

<ResponseField name="user" type="User Object">
  <Expandable title="properties">
    <ResponseField name="full_name" type="string">
      用户的全名
    </ResponseField>

    <ResponseField name="is_over_21" type="boolean">
      用户是否已满 21 岁
    </ResponseField>
  </Expandable>
</ResponseField>

​

属性

title · string

正在显示的对象名称。

defaultOpen · boolean · 默认值: "false"

设为 true，使展开项在页面加载时默认打开。