OpenAPI 라이선스 URL 점검

설명

info.license.url은 API의 라이선스 정보를 확인할 수 있는 링크입니다. 의도하지 않은 공백이나 잘못된 경로는 문서 접근을 방해할 수 있으며, 주소만 올바르다고 라이선스 이름과 내용까지 일치하는 것은 아닙니다.

잠재적 영향

사용자가 라이선스 조건을 확인하기 어렵고 배포나 재사용 검토에 추가 확인이 필요할 수 있습니다.

해결 방법

주소의 오타와 의도하지 않은 공백을 수정하고 실제 라이선스 문서로 연결하세요. 링크 대상이 license.name 및 제공하려는 조건과 일치하는지 확인하세요.

예시

Apache 2.0 문서 URL에 잘못 삽입된 공백을 제거하는 예시입니다. OpenAPI 3.0은 상대 URL도 허용하지만, 별도 라이선스 사이트는 명시적 주소로 연결하면 기준 주소에 따른 혼동을 줄일 수 있습니다.

변경 전

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/ LICENSE-2.0.html"
    }
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "200 response",
            "content": {
              "application/json": {
                "examples": {
                  "foo": {
                    "value": {
                      "versions": [
                        {
                          "status": "CURRENT",
                          "updated": "2011-01-21T11:33:21Z",
                          "id": "v2.0",
                          "links": [
                            {
                              "href": "http://127.0.0.1:8774/v2/",
                              "rel": "self"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

변경 후