Postman으로 Discourse API 사용하기 시작하기

[supermathie (Michael Brown)]

요약

Postman은 API에 대한 요청을 쉽게 구성하고 테스트할 수 있는 도구입니다.

Discourse와의 설정

1. Postman을 연 후 워크스페이스 만들기(Create Workspace)를 클릭하세요:

   

2. 빈 워크스페이스(Blank workspace)를 선택하고 다음(Next)을 클릭하세요.

3. 제목을 Discourse API로 지정하고 만들기(Create)를 선택하세요:

   

4. 컬렉션(Collections)을 클릭하세요:
   

   

5. 가져오기(Import)를 클릭하세요:
   

   

6. https://docs.discourse.org/openapi.json (docs.discourse.org에 표시된 “다운로드” URL)를 붙여넣으세요:
   

   

7. Postman Collection으로 가져오도록 선택하세요:
   

   

새 환경(Environment) 생성

1. 환경(Environments)과 환경 만들기(Create Environment)를 클릭하세요. 이는 테스트 중인 인스턴스에 특정된 변수를 저장하는 곳입니다. 이 예제에서는 try.discourse.org를 사용합니다.

   • 새 변수 defaultHost를 값 try.discourse.org와 함께 추가하세요:
   • ⑤ 환경 드롭다운에서 try.discourse.org 환경을 선택하세요
   

Hello World!

요청을 시도해 보겠습니다!

1. 컬렉션(Collections) → categories.json → 카테고리 목록 가져오기(Retrieves a list of categories)를 선택하고 보내기(Send)를 클릭하세요. 결과를 확인해야 합니다:
   
   

요청에 인증 추가

API 키 인증으로 API를 사용하려면:

1. 이 환경 또는 새 환경에 다음 변수를 추가하세요:

   • api-username
   • api-key
   
   
   (값은 물론 쿼리하는 사이트에서 유효해야 합니다)

2. 컬렉션에 스크립트를 추가하세요
   컬렉션(Collections) → Discourse API Documentation → 스크립트(Scripts) → 사전 요청(Pre-request)을 선택하고 다음을 붙여넣으세요:

   pm.request.headers.add({
       key: "api-key",
       value: pm.variables.get("api-key")
   })
   pm.request.headers.add({
       key: "api-username",
       value: pm.variables.get("api-username")
   })