Postman을 사용하여 카우치베이스 동기화 게이트웨이 쿼리하기

이 게시물에서는 Postman Chrome 개발자 도구를 사용하여 Couchbase 모바일 동기화 게이트웨이에서 제공하는 REST API를 쿼리, 탐색 및 테스트하는 편리한 방법에 대해 설명합니다. 동기화 게이트웨이는 클라이언트가 인터넷을 통해 상호 작용할 수 있는 REST, 배치 및 스트림 인터페이스를 노출합니다.

참고: 현재 프로덕션 릴리스인 Couchbase Mobile v1.4에 대해 논의할 예정입니다. 최신 개발자 프리뷰 버전 2.0 카우치베이스 모바일의

배경

카우치베이스 동기화 게이트웨이의 일부입니다. 카우치베이스 모바일 스택을 사용하며, 디바이스 간은 물론 디바이스와 클라우드 간에 데이터를 안전하게 동기화하는 인터넷 기반 동기화 메커니즘입니다. 동기화 게이트웨이가 요청을 수신하는 포트는 관리자 포트(기본값은 4985)와 공용 포트(기본값은 4984)의 두 가지가 있습니다. 프로덕션 배포에서 관리자 포트는 일반적으로 인터넷을 통한 액세스가 차단됩니다.

카우치베이스 동기화 게이트웨이 설치

블로그 게시물의 지침에 따라 다음과 같이 하세요. 동기화 게이트웨이 설치 를 사용하세요. 자세한 내용은 다운로드 사이트에서 사용 가능한 모든 패키지와 전체 설치 가이드 를 참조하세요. 지원되는 배포판 이외의 Linux 배포판에 설치하려면 다음을 참조하세요. 이 게시물.

포스트맨 설치

우편 배달원 에서 무료로 다운로드할 수 있는 Chrome 개발자 도구입니다. Chrome 브라우저 웹 스토어 .

포스트맨을 사용하여 카우치베이스 동기화 게이트웨이 쿼리하기

• 포스트맨 컬렉션 받기

동기화 게이트웨이의 관리자 및 공용 인터페이스에 대한 Postman 컬렉션 파일 및 환경 정의는 다음에서 다운로드할 수 있습니다. 깃허브 리포지토리.

다음 세 가지 파일이 있어야 합니다.

동기화 게이트웨이-관리자.postman_collection 

이것은 동기화 게이트웨이의 관리자 인터페이스에 해당하는 Portman 컬렉션입니다.

동기화 게이트웨이-공개.postman_collection

이것은 동기화 게이트웨이의 공용 인터페이스에 해당하는 Portman 컬렉션입니다.

동기화 게이트웨이-환경.postman_environment

관리 및 공개 컬렉션에서 사용하는 변수를 정의하는 환경 정의 파일입니다.

우편배달부 앱 실행

• 컬렉션 가져오기

아래 동영상의 단계에 따라 이전 단계에서 다운로드한 컬렉션을 가져오세요.

동기화 게이트웨이 포스트맨 컬렉션 가져오기

• 환경 파일 가져오기

아래 비디오의 단계에 따라 Postman 컬렉션에 해당하는 환경 정의를 가져오세요.

• 적절한 환경 설정

아래 비디오의 단계에 따라 방금 가져온 환경으로 환경을 설정합니다. 환경에 맞게 변수 값을 업데이트합니다. 변수 값의 관리자 는 관리 포트의 동기화 게이트웨이를 가리키고 publicurl 변수는 공용 포트의 동기화 게이트웨이를 가리킵니다. 기본값은 https://localhost:4985 그리고 https://localhost:4984 를 각각 입력합니다.

• 끝났습니다! 쿼리 실행

다음은 관리자 인터페이스에서 요청을 실행하는 데모입니다.

다음은 공개 인터페이스에서 요청을 실행하는 데모입니다. 적절한 인증 메커니즘을 사용하도록 인증 헤더를 적절하게 설정했는지 확인하세요.

동기화 게이트웨이의 공용 인터페이스 쿼리하기

CLI 옵션

명령줄 인터페이스에서 Postman 컬렉션을 실행하는 데 관심이 있는 경우(예: 지속적 통합 프로세스의 일부로 이를 통합하려는 경우) 다음을 확인해야 합니다.  Newman는 Postman용 CLI 러너입니다.

예를 들어, 아래 명령은 Sync-Gateway-Environment 파일과 함께 Sync-Gateway-Admin.postman_collection을 실행합니다.

동기화 게이트웨이가 SSL을 사용하도록 설정된 상태에서 실행 중이고 자체 서명 인증서를 사용하는 경우, "-k" 옵션은 인증서의 유효성 검사("안전하지 않은" SSL 연결)를 억제합니다. 프로덕션 환경에서는 이 옵션을 사용하지 않는 것이 좋습니다.

다음 단계

Postman 컬렉션은 동기화 게이트웨이에서 노출되는 REST 인터페이스를 쉽게 쿼리, 탐색 및 테스트할 수 있는 방법을 제공합니다. 컬렉션 정의에서 문제를 발견하거나 컬렉션을 개선하려면 풀 리퀘스트를 제출해 주세요. 깃허브 리포지토리.

더 궁금한 점이 있으면 언제든지 트위터로 문의해 주세요. @rajagp 또는 이메일을 보내주세요. priya.rajagopal@couchbase.com.

그리고 카우치베이스 모바일 개발자 포럼 는 모바일 관련 질문에 대한 답변을 얻을 수 있는 또 다른 좋은 장소입니다.

또한, 카우치베이스의 동기화 게이트웨이 API 정의 웹 인터페이스에 대한 자세한 내용을 확인하세요.