コンテンツ定義は、API 要求、応答、またはパラメーターのコンテンツを記述します。 API 定義内のさまざまな場所で以前に作成されたコンテンツ定義を編集することができます。
開始前に
コンテンツ定義の詳細フォームを開きます。 コンテンツ定義を編集できる API 定義内の領域の詳細については、以下のトピックを参照してください。
このタスクについて
このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。
いつでも、 「ソース」 アイコン 
をクリックして、基礎となる OpenAPI YAML ソースに直接切り替えることができます。 設計フォームに戻るには、 「フォーム」 アイコン 
をクリックします。
手順
- 以下の情報を指定します。
- コンテンツ・タイプ: コンテンツ・タイプ (例えば、 application/json) を選択します。
注: エディターの
「コンテンツ・タイプ」 フィールドにはメディア・タイプの選択リストが表示されますが、API の OpenAPI ソースを直接編集することで、
メディア・タイプ範囲(
text/*、
*/json、
*/*など) を指定できます。 複数のタイプに一致する要求または応答には、最も具体的なタイプのみが適用されます。 例えば、
text/plain は
text/* をオーバーライドします。
- スキーマ:
コンテンツ定義のスキーマを定義するには、 「作成」をクリックしてから、 スキーマ・コンポーネントの作成を参照してください。
コンテンツ定義に既にスキーマが定義されている場合は、「表示」をクリックして、そのスキーマを編集します。
スキーマの編集について詳しくは、
スキーマ・コンポーネントの編集を参照してください。
注: スキーマがスキーマ・コンポーネントを参照し、スキーマ構成がスキーマ・コンポーネントから継承されている場合、スキーマを編集することはできません。スキーマ・コンポーネントの構成について詳しくは、
スキーマ・コンポーネントの定義を参照してください。 参照先のスキーマ・コンポーネントを編集することはできますが、変更はそのスキーマ・コンポーネントが参照されているすべての場所に反映されます。
- サンプル値: パラメーター値のサンプル。 ここで入力した内容は、そのまま CMS ポータルに表示されます。
- 例:
コンテンツの例を追加するには、 「追加」をクリックしてから、 サンプルの作成を参照してください。
既存のサンプルを編集するには、サンプル名をクリックしてから、 サンプルの編集を参照してください。
- エンコード: エンコード定義は、特定のスキーマ・プロパティーをどのようにエンコードするかを記述します。
エンコード定義を追加するには、 「追加」をクリックしてから、 エンコード定義の作成を参照してください。
既存のエンコード定義を編集するには、名前をクリックしてから、 エンコード定義の編集を参照してください。
- 完了したら、 「保存」 をクリックします。
次のタスク
必要に応じて、パンくずリストを使用して、作業対象のオブジェクトの階層内の別の場所にナビゲートします。