ApidogにおけるSecurity Scheme
Security Schemeとは？#
Security Schemeは、OpenAPI Specification (OAS)に従ってAPIの認証方法を定義する手段です。各APIに個別に認証を設定する代わりに、認証方法を実際の認証情報から分離した再利用可能なテンプレート（Security Scheme）を作成できます。これにより、チームは認証設定をより柔軟に管理、更新、再利用しやすくなります。Security Schemeを使う理由#
一度定義してどこでも使用: 一度Security Schemeを作成すれば、複数のAPIやフォルダで再利用可能。
柔軟な組み合わせ: APIは複数の種類のSecurity Schemeを使用可能。
テンプレートと値の分離: 認証ルール（テンプレート）と実際の値（認証情報）を分離することで、管理が容易に。
認証情報の漏洩防止: オンラインドキュメントでSecurity Schemeを使ってAPIをテストする際、認証情報は手動で入力する必要がある。
自動継承: APIは親フォルダからSecurity Schemeを自動的に継承でき、設定の繰り返しを削減。
主要な認証方法をサポート: APIキー、Bearerトークン、Basic認証、OAuth 2.0などを含む。
OpenAPI準拠: OpenAPI 3.0 Security Schemes仕様に完全対応。
いつ使うべきか？#
チームが共同作業を行い、認証を統一的に管理する必要がある場合。
OpenAPIドキュメントに明確で標準化されたセキュリティ定義を含めたい場合。
Modified at 2025-04-27 09:08:10
