Security Schemes とは何ですか?#
Security Schemes は、OpenAPI Specification(OAS)に従って、エンドポイントの認証方法を定義するための仕組みです。各エンドポイントに個別に認証を設定する代わりに、認証方法を実際の認証情報から分離した再利用可能なテンプレート(security scheme)を作成できます。これにより、チームは認証設定をより柔軟に管理、更新、再利用しやすくなります。Security Schemes を使用する理由#
一度定義して、どこでも使用:security scheme を一度作成すれば、複数のエンドポイントやフォルダーで再利用できます。
柔軟な組み合わせ:1 つのエンドポイントで複数種類の security scheme を使用できます。
テンプレートと値の分離:認証ルール(テンプレート)を実際の値(認証情報)から分離して保持することで、保守が容易になります。
認証情報の漏えいを防止:オンラインドキュメント上で security scheme を使用してエンドポイントをテストする場合、認証情報は手動で入力する必要があります。
自動継承:エンドポイントは親フォルダーから security scheme を継承できるため、繰り返し設定を減らせます。
主要な認証方法をすべてサポート:API Key、Bearer Token、Basic Auth、OAuth 2.0 などに対応しています。
OpenAPI 準拠:OpenAPI 3.0 Security Schemes 仕様と完全に互換性があります。
いつ使用すべきですか?#
複数のエンドポイントが同じ認証方法を共有している場合。
1 つのエンドポイントで複数の認証タイプが必要な場合。
チームで共同作業をしており、認証を管理するための統一された方法が必要な場合。
OpenAPI ドキュメントに明確で標準化されたセキュリティ定義を含めたい場合。
Modified at 2026-06-11 07:06:02