OpenAPI 연락처 이메일 점검

설명

OpenAPI의 info.contact.email은 API 관련 문의를 받을 이메일 주소입니다. 잘못된 표기나 도메인 오타는 연락을 방해하며, 형식이 맞는다는 사실만으로 메일함의 존재나 수신 가능 여부가 보장되지는 않습니다.

잠재적 영향

API 사용자나 협업자가 지원 담당자에게 연락하지 못하거나 잘못된 대상에게 문의를 보낼 수 있습니다.

해결 방법

연락처의 로컬 파트와 도메인을 확인하고 실제로 관리하는 수신 주소를 제공하세요. 문서에 표시되는 주소와 운영 지원 채널이 일치하는지도 확인하세요.

예시

gmail.com을 의도했지만 gmail.c로 잘못 적은 상황을 가정한 예시입니다. 특정 최상위 도메인의 글자 수만으로 모든 이메일 주소의 유효성을 판단하지 마세요.

변경 전

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0",
    "contact": {
      "name": "contact",
      "url": "https://www.google.com/",
      "email": "user@gmail.c"
    }
  },
  "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"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

변경 후