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"
}

참조