可展开项

切换显示嵌套属性

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

user · User Object

显示 properties

full_name · string

用户的全名

is_over_21 · boolean

用户是否年满 21 岁

可展开示例

<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 以在页面加载时自动展开。