説明
TRACE は、サーバーが受信したリクエストを返す診断用メソッドです。サポートしている操作の 200 成功レスポンスが文書にないと、呼び出し側は正常な結果を理解しにくくなります。
想定される影響
文書に基づくクライアントやテストが、診断レスポンスを誤って解釈する可能性があります。
対処方法
サポートしている TRACE の responses に、200 とレスポンス形式を説明してください。サービスが TRACE をサポートしない場合は、文書からもその操作を削除してください。
例
次のOpenAPI 3.0の抜粋では、すでにサポートしている TRACE 操作に 200 を追加しています。文書を変更しても、サーバーでメソッドが有効になるわけではありません。
変更前
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"trace": {
"operationId": "traceItem",
"responses": {
"default": {
"description": "Error"
}
}
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"trace": {
"operationId": "traceItem",
"responses": {
"200": {
"description": "success"
},
"default": {
"description": "Error"
}
}
}
}
}
}