API ドキュメント内の繰り返し部分をデータ構造に抽出できるため、他のドキュメントで再利用するのに便利です。データ構造が変更されると、そのデータ構造を参照するすべての API ドキュメントが同期的に変更されます。
データ構造の作成
データ構造管理ページに入り、「データ構造の追加」ボタンをクリックし、関連する内容を入力して保存します。
APIドキュメントでデータ構造を導入する
API 編集ページに入り、パラメーターを追加するときに既存のデータ構造を参照することを選択し、ポップアップ ウィンドウで参照するデータ構造を選択して、「OK」をクリックします。
参照されたデータ構造はページ上で赤い背景でマークされ、参照されたデータ構造のコンテンツの一部 (パラメーター名を除く) を再度変更できます。
データ構造をパラメータタイプとしてAPIドキュメントに含める
パラメータ タイプのドロップダウン ボックスでデータ構造を選択できます。
API ドキュメントの詳細ページでは、パラメータの型としてデータ構造を使用するフィールドが青色で表示され、クリックするとポップアップ ウィンドウにデータ構造の詳細が表示されます。
データ構造を変更する
データ構造が変更されると、そのデータ構造を参照するすべての API が変更されます。
参考資料を見る
応答データ構造の右側に参照参照ボタンがあり、参照状況を参照できます
データ構造を削除する
データ構造を削除する前に、システムは現在のデータ構造が参照されているかどうかを確認します。参照されている場合は、最初に参照を削除するか、API を削除する必要があります。
データ構造管理ページに入り、該当するデータ構造を選択し、データ構造の削除ボタンをクリックします（データ構造が参照されている場合、削除ボタンは使用できません）。
