계정 만들기
- 무료 계정은 https://www.postman.com에서 만들 수 있습니다.
워크스페이스 만들기
- 워크스페이스 이름을 지정하고 공개 범위를 설정합니다.
컬렉션 생성
- 왼쪽 상단 메뉴에서 “Explore” 아래의 “Import”를 클릭합니다:
- 모달 창이 나타납니다:
- API 주소 “https://api.clickhouse.cloud/v1"를 입력하고 ‘Enter’를 누릅니다:
- “Import” 버튼을 클릭한 다음 “Postman Collection”을 선택합니다:
ClickHouse Cloud API 사양과 연동하기
- 이제 “ClickHouse Cloud용 API 사양”이 “Collections”(왼쪽 탐색 메뉴)에 표시됩니다.
- “ClickHouse Cloud용 API 사양”을 클릭합니다. 가운데 창에서 ‘Authorization’ 탭을 선택하세요:
- 드롭다운 메뉴에서 “Basic Auth”를 선택합니다:
- ClickHouse Cloud API keys를 설정할 때 받은 사용자 이름과 비밀번호를 입력합니다:
변수 사용 설정
- 변수를 사용하면 Postman에서 값을 저장하고 재사용할 수 있어 API 테스트를 더 쉽게 진행할 수 있습니다.
조직 ID와 서비스 ID 설정
- “Collection”에서 가운데 창의 “Variable” 탭을 클릭합니다(기준 URL은 앞서 API를 가져올 때 이미 설정되어 있습니다).
baseURL아래의 빈 “Add new value” 필드를 클릭한 다음, 조직 ID와 서비스 ID를 입력합니다:
ClickHouse Cloud API 기능 테스트
”GET 사용 가능한 조직 목록” 테스트
- “ClickHouse Cloud용 OpenAPI spec” 아래에서 폴더 > V1 > organizations를 펼치십시오.
- “GET 사용 가능한 조직 목록”을 클릭한 다음, 오른쪽의 파란색 “Send” 버튼을 누르십시오.
- 반환된 결과에는 “status”: 200과 함께 조직 상세 정보가 표시되어야 합니다. (“status” 400이 반환되고 조직 정보가 표시되지 않으면 구성이 올바르지 않은 것입니다.)
”GET 조직 세부 정보” 테스트
organizationid폴더 아래에서 “GET 조직 세부 정보”로 이동합니다:- 가운데 프레임 메뉴의 Params 아래에서
organizationid를 입력해야 합니다.
- 이 값을 중괄호로 감싼
orgid값인{{orgid}}로 수정합니다(앞서 이 값을 설정했다면 해당 값이 포함된 메뉴가 표시됩니다):
- “Save” 버튼을 누른 후, 화면 오른쪽 상단의 파란색 “Send” 버튼을 누릅니다.
- 반환된 결과에는 “status”: 200과 함께 조직 세부 정보가 표시되어야 합니다. (“status” 400이 표시되고 조직 정보가 반환되지 않으면 구성이 올바르지 않은 것입니다).
”GET service details” 테스트
- “GET service details”를 클릭하세요.
organizationid및serviceid의 값을 각각{{orgid}}및{{serviceid}}로 수정하세요.- “Save”를 누른 다음 오른쪽의 파란색 “Send” 버튼을 누르세요.
- 반환된 결과에는 “status”: 200과 함께 서비스 목록 및 각 서비스의 세부 정보가 표시되어야 합니다. (“status” 400이 표시되고 서비스 정보가 없으면 구성이 올바르지 않은 것입니다.)