hostの形式が不正(OpenAPI 2.0)

APIホストにパスやプロトコルなどの不正な要素が含まれる状態

説明

OpenAPI 2.0の host には、ホスト名またはIPアドレスと、必要に応じてポートのみを指定します。プロトコルとパスは、それぞれ schemes と basePath に定義します。

想定される影響

文書ツールや生成されたクライアントが、誤ったサーバーアドレスを使う可能性があります。

対処方法

host からプロトコルとパスを分離し、必要なポートだけを含めてください。各フィールドを組み合わせたURLが、意図したAPIアドレスになることを確認してください。

例

次の抜粋では、パスを含む kics.io/test と、ホスト・ポート形式の 127.0.0.1:8080 を比較しています。ローカルアドレスは形式を示す例なので、実際のAPIホストに置き換えてください。

変更前

json
{
  "swagger": "2.0",
  "host": "kics.io/test"
}

変更後

json
{
  "swagger": "2.0",
  "host": "127.0.0.1:8080"
}

参考資料