説明
OpenAPI 2.0のproducesは、レスポンス本文のメディアタイプを表します。本文を返すGET操作で、全体にも操作にも定義がないと、クライアントが期待する形式を判断しにくくなります。
想定される影響
クライアントが誤ったパーサーやレスポンス形式を選び、データを処理できなくなる可能性があります。
対処方法
実際のレスポンスのメディアタイプを、全体または操作のproducesに指定してください。操作の定義は全体の値を上書きします。レスポンス本文とContent-Typeヘッダーが文書に一致することも確認します。
例
この例では、JSONを返す操作にproduces: [application/json]を追加しています。
変更前
yaml
swagger: "2.0"
paths:
/users:
get:
responses:
"200":
description: ok
変更後
yaml
swagger: "2.0"
paths:
/users:
get:
produces:
- application/json
responses:
"200":
description: ok