展開セクション

トグルでネストされたプロパティを表示

レスポンスフィールド内のネストされたコンテンツの表示・非表示には展開セクションを使用します。展開セクションは、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 を設定します