APIのスキーマ定義の設定

OpenAPI （ 2.0 ）で作成されたAPIには、APIのペイロード定義が記述されるセクションが含まれています。 ペイロード定義は、 OpenAPI 専用の特殊な JSON スキーマのバリエーションを用いて、API リクエストおよびレスポンスで送信されるデータの構造を記述しています。 各ペイロード定義は、想定されるデータフィールドを列挙したスキーマに対応しています。 これらのデータフィールドは、スキーマ内のプロパティとして定義され、その型、許容値、必須かどうか、およびその他の特性を記述する一連の属性を含んでいます。 利用可能な属性は数多くありますが、その大部分はあまり使われていません。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

「ソース 」アイコンをクリックすると、いつでも直接、基盤となる OpenAPIのYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください 。