로컬 환경에서 웹훅(Webhook) 테스트하기 - ngrok 사용 가이드

오늘은 로컬 환경에서 배포없이 웹훅 테스트를 하는 방버에 대해 작성해 보려고 하는데요!

가장 고민이 어떻게 배포 없이 내 로컬 서버에 웹훅 메세지를 받을 수 있을까 였습니다. 그러다가 ngrok을 알게 됐고 무료로 특정 포트에 url 값을 부여할 수 있다는 점이 굉장히 매력 있었습니다. 사용법도 굉장히 간단합니다.

 

1. 간편한 설정과 실행

• 설치는 패키지 매니저로 한 줄로 가능 실행도 한 줄로 가능
• GUI 클라이언트 제공으로 비개발자도 쉽게 사용 가능

2. 뛰어난 개발자 경험

• 실시간 트래픽 모니터링 대시보드 제공
  • 모든 요청/응답의 헤더, 본문을 보기 좋게 포매팅하여 표시
  • 응답 시간, 상태 코드 등 성능 지표 실시간 확인
• 받은 웹훅을 그대로 다시 보낼 수 있는 재전송 기능
• 특정 요청의 모든 정보를 팀원과 공유 가능

3. 다양한 프로토콜 지원

• HTTP/HTTPS는 물론 TCP, WebSocket까지 지원
• 자동 SSL/TLS 암호화 제공
• Basic Auth 등 기본적인 보안 기능 제공

 

맥 기준 다운로드 사이트(다른 운영체제를 사용하셔도 링크 들어가셔서 상단 오른쪽보시면 쉽게 변경 가능합니다.)

https://dashboard.ngrok.com/get-started/setup/macos

ngrok - Online in One Line

 

가입을 안 하고 사용하는 방법도 있지만 가입 후 사용하는 방법을 알려드릴게요 왜냐면 가입을 안 하면 url이 2시간만 유지되도록 되어있어서 계속 갱신해야 하는 번거로움이 있습니다!

 

가입은 그냥 여느 사이트와 같으니 따로 알려드리지 않겠습니다. 

 

가입을 하셨다면 아래와 같이 굉장히 친절한 화면이 나옵니다. 

그럼 명령어를 그대로 복사만 해주시면 완료입니다. 대신 마지막 포트를 넣는 부분에는 본인이 사용하시는 포트로 변경해주세요 :)

 

여기 있는 명령어를 터미널 창에서 모두 입력하셨다면 화면 맨 아래 주소들은 제가 테스트 한 것들이니 없다고 이상하게 생각하지마세요

 

추가적으로 이 url은 터미널 창이 유지되고 있어야지만 url도 유지됩니다. 다시 시작하신다면 다시 명령어를 입력해서 실행하면 되는데 Url은 바뀔테니 이 점 주의해주세요

 

지금까지 로컬 개발 환경에서 웹훅을 테스트할 때 유용한 도구인 ngrok에 대해 알아보았습니다. 웹훅 개발시 매번 서버에 배포해가며 테스트하는 건 너무나 번거로운 일인데, ngrok을 사용하면 이런 불편함을 크게 줄일 수 있습니다.  특히 실시간으로 들어오는 요청을 바로바로 확인할 수 있는 점이 매우 유용했습니다. 다만 회사 프로젝트에서 사용하실 때는 보안 정책을 먼저 확인하시는 것을 추천드립니다. 로컬 환경이 외부에 노출되는 것이므로, 민감한 데이터를 다루는 경우라면 팀원들과 충분한 논의가 필요할 수 있겠죠.

 

이 글이 웹훅 개발로 고민하시는 분들께 도움이 되었기를 바랍니다. 혹시 ngrok을 사용하면서 겪은 경험이나 팁이 있다면 댓글로 공유해주세요!