用語の定義

OpenAPI ドキュメント

API または API の要素を定義または説明する自己完結型または複合リソース。OpenAPI ドキュメントには、少なくとも 1 つのパスフィールド、コンポーネントフィールド、またはWebhookフィールドが含まれていなければなりません。OpenAPI ドキュメントは OpenAPI 仕様を使用し、OpenAPI 仕様に準拠します。

パスのテンプレート化

パス テンプレート化とは、中括弧 ({}) で区切られたテンプレート式を使用して、パス パラメーターを使用して URL パスのセクションを置換可能としてマークすることを指します。

パス内の各テンプレート式は、パス アイテム自体および/またはパス アイテムの各オペレーションに含まれるパス パラメーターに対応しなければなりません (MUST) 。例外は、たとえば ACL 制約によりパス項目が空の場合であり、一致するパス パラメータは必要ありません。

これらのパス パラメーターの値には、RFC3986で記述されているエスケープされていない「一般的な構文」文字(スラッシュ ( /)、疑問符 ( ?)、またはハッシュ ( #)) を含めてはなりません。

メディアの種類

メディア タイプの定義は、複数のリソースに分散されています。メディアタイプの定義はRFC6838に準拠している必要があります (SHOULD )。

考えられるメディア タイプ定義の例をいくつか示します。

  text/plain; charset=utf-8  application/json  application/vnd.github+json  application/vnd.github.v3+json  application/vnd.github.v3.raw+json  application/vnd.github.v3.text+json  application/vnd.github.v3.html+json  application/vnd.github.v3.full+json  application/vnd.github.v3.diff  application/vnd.github.v3.patch

HTTPステータスコード

HTTP ステータス コードは、実行された操作のステータスを示すために使用されます。利用可能なステータス コードはRFC7231によって定義されており、登録されたステータス コードはIANA ステータス コード レジストリにリストされています。