説明
OpenAPI 3.0のtype: httpでは、schemeがAuthorizationヘッダーで使用するHTTP認証方式を表します。相互運用性のため、IANAに登録された認証方式の名前を使用することが推奨されています。
想定される影響
誤記や未対応の認証方式により、誤ったヘッダーが生成されたり、クライアント連携に失敗したりする可能性があります。
対処方法
schemeをサーバーが実際に使用する認証方式と一致させ、IANAの登録名を確認してください。独自の方式が必要な場合は、その規約を文書化し、クライアントや関連ツールの対応を確認します。
例
変更後の例は、サーバーがBasic認証を使用する場合です。実際のサーバーが別の方式を使用する場合は、それに合わせて指定してください。認証情報はHTTPSで送信してください。
変更前
json
{
"openapi": "3.0.0",
"components": {
"securitySchemes": {
"petstore_auth": {
"type": "http",
"scheme": "test"
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"components": {
"securitySchemes": {
"petstore_auth": {
"type": "http",
"scheme": "basic"
}
}
}
}