可展开项

切换显示嵌套属性

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

user · User Object

Show 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 · default: "false"

设为 true，页面加载时即展开