Hookdeck CLI를 사용한 로컬 Webhook 개발

많은 개발자들에게 웹훅을 사용하는 것은 스트레스를 받을 수 있다.일반적으로 개발자는 로컬 터널 솔루션을 설정하고 외부 요청을 로컬 서버에 프록시하며 웹훅의 유효 부하를 검사하는 도구를 설정해야 한다.개발 환경에서 Webhooks를 사용하는 데 적합한 도구가 부족하기 때문에 Hookdeck CLI를 구축할 수 있습니다.
Hookdeck CLI는 로컬 컴퓨터의 포트에 외부 요청을 프록시하고 웹훅의 유효 부하를 검사하는 명령줄 인터페이스입니다.비록 다른 방법과 원리를 사용했지만, Hookdeck CLI는 Ngrok과 다른 HTTPS 터널 솔루션의 대체품이다.Hookdeck CLI를 사용하면 최소한의 설정만 있으면 개발자가 웹훅 개발 작업 흐름의 더 중요한 부분에 전념할 수 있습니다.
이 설명서에서는 Hookdeck CLI를 사용하여 로컬에서 웹훅 통합을 개발하고 테스트하는 방법을 학습합니다.또한 Dev.to webhook 제품을 예로 삼아 단계적으로 통합할 예정입니다.
이 문서를 읽은 후 다음 사항을 학습합니다.
  • Hookdeck CLI 설정
  • 로컬 호스트
  • 에서 이벤트 수신
  • 갈고리 계기판
  • 의 유효 하중 검사

    로컬 서버 설정


    Hookdeck CLI가 로컬 웹훅 개발을 어떻게 간소화하는지 설명하기 위해 Dev.To 웹훅스와 통합할 것입니다.통합은 간단한 서버로 구성되어 있으며, 이 서버는 지정한 이벤트를 터치할 때 웹훅 알림을 받고, 알림을 컨트롤러에 출력합니다.먼저 NodeJs 프로젝트를 초기화하고 새로 만든 index.js 파일에 다음 코드 행을 추가합니다.
        const express = require("express");
        const app = express();
    
        app.post("/webhook", async (req, res) => {
          console.log(req.body)
          res.status(200).send("ok")
        });
    
        app.listen(3000, () => console.log(`App is running on port 3000`));
    
    우리가 방금 만든 간단한 서버는 Dev.to로부터 알림을 받을 것입니다. 그리고 Dev.to를 웹hooks에 등록한 후에 알림을 컨트롤러에 인쇄할 것입니다.
    웹훅에 개발자를 등록할 때, 웹 훅 알림을 받을 대상 URL을 제공해야 합니다.개발 모드이기 때문에 Hookdeck CLI를 사용하여 외부 요청을 서버에 프록시하고 대상 URL을 생성합니다.

    Hookdeck CLI 사용


    장치
    Hookdeck CLI의 다양한 기능을 탐색하기 전에 로컬 컴퓨터에 설치해야 합니다.기계가 운행하는 운영 체제에 따라 설치 방법이 약간 다르다.다양한 설치 방법은 다음과 같습니다.
  • MacOS 설치
  • Hookdeck CLI는 자체 제작 소프트웨어를 사용하여 MacOS에 설치할 수 있습니다.Homebrew는 MacOS의 패키지 관리자입니다.다음 명령을 실행하여 Mac에 Hookdeck CLI를 설치합니다.
    brew 설치hookdeck/hookdeck/hookdeck
  • Windows 설치
  • Windows 컴퓨터에서는 다음 명령을 실행하여 scoop 패키지 관리자를 통해 Hookdeck CLI를 설치할 수 있습니다.
    $spook bucket add 훅https://github.com/hookdeck/scoop-hookdeck-cli.git
    $45 갈고리 설치
  • Linux 설치
  • Linux 시스템에 Hookdeck CLI를 설치하려면 다른 운영 체제보다 몇 가지 절차가 필요합니다.선택한 Linux 릴리스에 Hookdeck CLI를 설치하려면 다음과 같이 하십시오.
  • 최신 Linux tar를 다운로드하십시오.gz 파일 출처https://github.com/hookdeck/hookdeck-cli/releases/latest
  • 압축해제 파일: tar-xvf hookdeck X.X linux x86 64.타르.gz
  • 압축 풀기 디렉터리로 이동
  • 실행 파일 실행:/후크 갑판
  • 운영 체제와 관련된 절차를 따르려면 로컬 컴퓨터에 Hookdeck CLI를 설치해야 합니다.CLI가 제대로 설치되었는지 테스트하려면 다음 명령을 실행하십시오.
    $ hookdeck version
    
    Hookdeck CLI가 제대로 설치되어 있는 경우 설치된 Hookdeck CLI 버전이 인쇄되어 있어야 합니다.본문을 작성할 때 Hookdeck의 최신 버전은 0.2이다.
    수업을 시작하다
    Hookdeck CLI가 설치되면 로컬 서버에서 웹훅 알림을 받을 수 있도록 새 연결 및 전송 요청을 수신하도록 구성해야 합니다.수신 요청을 수신하려면 먼저 Hookdeck 계정에 로그인해야 합니다.로그인하려면 $ hookdeck login 명령을 실행하십시오.[amp]lt;Enter[amp]gt; 키를 누르고 브라우저로 안내하라는 메시지가 나타나면 Hookdeck CLI와 다른 기능의 상호 작용을 확인하고 권한을 부여받을 수 있습니다.API 키를 수동으로 제공하여 인증하려면 $ hookdeck login 플래그를 사용하여 -i 명령을 실행할 수도 있습니다.
    전달 세션을 시작하려면 다음 명령을 실행합니다hookdeck listen 3000.Hookdeck "listen"명령을 실행할 때 로컬 서버가 실행하는 정확한 포트를 매개 변수로 사용하는 방법을 주의하십시오.이 명령을 실행하면 기존 소스를 선택하거나 새 소스를 생성하라는 메시지가 표시됩니다.[새 소스 만들기] 옵션을 선택하고 소스 탭Devto webhooks으로 프롬프트를 채웁니다.
    CLI 프롬프트의 다음 질문에서는 위쪽에 생성된 서버, 즉 /webhook 라우트를 기반으로 하는 Webhook이 전달할 경로를 로컬 서버에 지정해야 합니다.연결 탭을 요청하는 알림에 연결을 만들기 위한 좋은 별명을 입력하십시오.웹 훅에 개발자를 등록할 때 사용할 URL을 손에 넣으십시오.

    경탄할 만한!이제 Hookdeck CLI를 설정하고 수신 요청을 수신했습니다.

    회선에 카드가 걸린 경우 다음 명령을 실행하여 Hookdeck CLI 도움말 메뉴에 액세스하십시오.
    $ hookdeck --help
    $ hookdeck -h
    
    개발자를 웹훅스에 등록하기
    이제 요청을 수신하고 로컬 서버로 전송하기 위해 Hookdeck CLI를 성공적으로 설정했으며 Dev.to webhook을 계속 등록할 수 있습니다.Dev.To webhooks에 등록하려면 Dev.To API/webhook 라우팅에 POST HTTP 요청을 보내야 합니다.Dev.to에 대한 요청의 유효 로드에는 대상 URL 필드가 포함되며 이 값은 Hookdeck이 연결된 URL입니다.Dev.to webhook에 POST 요청을 보내는 예제 로드는 다음 JSON 객체와 유사해야 합니다.
        {
          "webhook_endpoint": {
            "target_url": "https://events.hookdeck.com/e/src_5UbKi..."
            "source": "DEV",
            "events": [
              "article_updated"
            ]
          }
        }
    
    Dev.to API에 POST 요청을 보내면 이벤트article_update가 트리거될 때마다 다음과 같은 출력이 터미널로 인쇄됩니다.

    유효 하중 확인
    외부 요청을 로컬 기기의 포트에 프록시하는 것 외에 Hookdeck CLI는 웹훅의 유효 부하를 검사하는 데 매우 유용하다.Dev.to webhooks에서 받은 유효 부하를 확인하려면 다음 절차를 따르십시오.
  • 스누핑 세션을 시작한 후 Hookdeck에서 제공하는 inspect URL을 복사합니다.
  • 웹 훅 부하를 보고 검사하기 위해 브라우저의 URL에 접근합니다.Hookdeck 대시보드의 유효 부하 출력은 다음 그림과 유사해야 합니다. 이것은 Dev.to가 보낸 웹 훅 알림의 주체와 제목을 볼 수 있습니다.
  • 요컨대


    Hookdeck CLI를 설정하고 외부 요청을 로컬 서버에 에이전트하며 올바른 로드를 확인하는 방법을 배웠습니다.Hookdeck CLI는 웹훅스의 전체 프로세스를 로컬에서 원활하게 처리하는 데 도움이 됩니다.
    더 많은 것을 알고 싶으세요?Hookdeck을 따라가면 웹훅스에 대한 강좌와 안내서를 공유할 것입니다!
    Try Hookdeck For Free . 한 곳에서 모든 웹훅을 수신, 감시, 관리하다.Dell은 고객이 제품 구축에 집중할 수 있도록 복잡성을 처리합니다.
    어휘표
  • SourceSource는 Shoopify, Stripe, Github 등 웹훅을 보내는 API를 대표합니다. 원본마다 유일한 웹훅 URL이 분배되어 발송자에게 제공됩니다.
  • ADestination는 서버의 엔드포인트를 나타냅니다.Hookdeck은 HTTP POST 요청을 통해 받은 모든 WebHook을 이 URL에 전송합니다. 이 요청은 발송자의 원본 데이터와 추가된 Hookdeck 메타데이터를 포함합니다.
  • 좋은 웹페이지 즐겨찾기