[NestJS] 이메일 유효성 검사 API 명세서 작성&테스트 삽질기&회고(1)

고진감래라고, 힘겹게 완성한 API가 잘 동작해주기만 하면 그동안의 스트레스가 싹 날아갈 것만 같다.

하지만 테스트하는 순간까지 고진감래는 커녕 고진고래(...)인 상태가 지속되었다.

먼저, API 명세서 작성을 하였다.(사실 지난번 코드에 명시된 바 있다) 일단 여기까지는 순조로웠다..

 

1. 테스트 환경 설정: 테스트하기 전에 Nest.js 프로젝트가 실행 가능한 상태인지 확인해야 합니다. 필요한 종속성이 설치되었는지 확인하고, 프로젝트를 실행할 수 있는 상태인지 확인하세요.
2. API 엔드포인트 확인: 이메일 유효성을 확인하는 API의 엔드포인트 경로와 HTTP 메서드를 알아야 합니다. 일반적으로 /api/email/validate 또는 유사한 경로일 수 있습니다. 해당 엔드포인트의 요청 방식(GET, POST 등)을 알아두세요.
3. API 요청 보내기: 선택한 API 테스트 도구(예: Postman, cURL, Insomnia 등) 를 사용하여 해당 엔드포인트에 요청을 보낼 수 있습니다.
   • GET 요청의 경우:
   •  

     GET http://localhost:3000/api/email/validate?email=test@example.com
     

   • POST 요청의 경우:
   •  

     POST http://localhost:3000/api/email/validate
     Content-Type: application/json
     
     {
       "email": "test@example.com"
     }
     

   위 예시에서 http://localhost:3000은 Nest.js 서버가 실행 중인 로컬 호스트 및 포트 번호입니다. 실제로 사용하는 호스트 및 포트 번호에 맞게 수정하세요.
4. 응답 분석: 서버에서 반환된 응답을 분석하여 이메일 유효성 검사 결과를 확인할 수 있습니다. 일반적으로 성공 또는 실패 여부와 함께 추가 정보가 포함됩니다.

위 단계들을 따라 진행하면서 이메일 유효성 검사 API를 테스트해보세요. 필요에 따라 API 동작과 관련된 추가적인 정보나 코드 스니펫을 제공해주시면 보다 구체적으로 도움을 드릴 수 있습니다.

(*스니펫: 작은 코드 조각이라는 뜻으로, 재사용 가능한 소스 코드, 기계어, 텍스트의 작은 부분을 일컫는 프로그래밍 용어이다. 사용자가 루틴 편집 조작 중 반복 타이핑을 회피할 수 있게 도와준다.)

라는데... 우리 프로젝트는 Swagger 라는 혁신적인(?) UI가 탑재된, Web API 문서화를 위한 프레임워크를 사용 중이었기 때문에 전혀 위와 같은 과정이 필요 없다! 지금까지는 Swagger만큼 가독성 좋고 편한 프레임워크는 못 본 것 같다.

 

Nest.js 프로젝트에 Swagger를 사용하여 API 문서화를 했다면, Swagger UI를 통해 API를 테스트할 수 있습니다.

Swagger UI는 프로젝트의 엔드포인트와 해당 엔드포인트에 대한 요청을 시각적으로 제공하며, 테스트하기 쉽게 만들어줍니다.

아래는 Swagger UI를 사용하여 API를 테스트하는 방법입니다:

1. Nest.js 서버 실행: 먼저, Nest.js 프로젝트가 실행 중이어야 합니다. 필요한 종속성이 설치되었는지 확인하고, npm run start 또는 yarn start 명령을 사용하여 서버를 실행하세요.
2. Swagger UI 접속: 웹 브라우저에서 다음 URL을 입력하여 Swagger UI에 접속합니다:위 예시에서 http://localhost:3000은 Nest.js 서버가 실행 중인 로컬 호스트 및 포트 번호입니다. 실제로 사용하는 호스트 및 포트 번호에 맞게 수정하세요.

   http://localhost:3000/api
   

3. API 테스트: Swagger UI에서 제공되는 인터페이스를 사용하여 이메일 유효성 검사 API의 요청을 구성하고 보낼 수 있습니다. 필요한 매개변수(예: 이메일 주소)와 함께 요청을 작성하고 "Try it out" 버튼을 클릭하세요.
4. 응답 확인: 서버에서 반환된 응답은 Swagger UI에서 시각적으로 표시됩니다. 성공 또는 실패 여부와 함께 추가 정보가 제공될 것입니다.

Swagger UI를 사용하여 Nest.js API를 직접 테스트할 수 있으므로, 별도의 도구 없이도 간편하게 작업할 수 있습니다.

 

이런 식이다. 이 얼마나 직관적이고 간결한가... 난 앞으로도 스웨거를 애용하게 될 듯 하다.