그리고 카우치베이스 동기화 게이트웨이 는 Couchbase Mobile 스택의 핵심 구성 요소 중 하나입니다. 높은 수준에서 웹 및 모바일 클라이언트와 Couchbase 서버 간에 데이터를 안전하게 라우팅하고 동기화하는 역할을 담당합니다. 클라이언트가 다음을 수행할 수 있는 REST API를 지원합니다. 관리자 그리고 비관리자 작업을 수행해야 합니다. 동기화 게이트웨이와 인터페이스하는 클라이언트 앱을 개발하는 경우 API를 탐색하고 테스트할 수 있는 편리한 방법이 필요하며, 동기화 게이트웨이에 대한 모든 호출을 모방할 수도 있습니다. 이를 위해 Postman을 사용할 수 있습니다.
우편 배달원 는 API 테스트, 개발 및 문서화 도구입니다. 동기화 게이트웨이는 관리자 및 공용 REST 인터페이스에 해당하는 Postman 컬렉션을 지원합니다. 이전 post에서 동기화 게이트웨이 API 테스트를 위해 Postman을 시작하는 방법에 대한 기본 사항을 다루었습니다. 그 이후로 동기화 게이트웨이 포스트맨 컬렉션에 상당한 개선이 이루어졌으며 물론 포스트맨 자체도 변경되었습니다. 이 글에서는 컬렉션 정의의 개선 사항에 대해 설명합니다. 이 게시물에는 동영상 데모도 포함되어 있습니다.
이 글에서 설명하는 모든 내용은 무료 커뮤니티 버전의 Postman 도구를 사용합니다.
배경
Couchbase 모바일 스택은 Couchbase 서버, Couchbase 동기화 게이트웨이 및 Couchbase Lite 임베디드 데이터베이스로 구성됩니다. 이 글에서는 Couchbase Mobile 스택에 대해 잘 알고 있다고 가정합니다. Couchbase에 대해 더 자세히 알고 싶으시면 리소스 를 클릭하세요.
또한 이 글에서는 Postman 사용에 대한 기본적인 이해가 있다고 가정합니다. 다시 한 번 살펴보고 싶으시다면 다음을 확인하세요. 이 out.
TL;DR
원하신다면 이 블로그 게시물에서 설명하는 모든 내용을 데모로 보여주는 아래 동영상을 확인하실 수 있습니다.
Postman 설치하기
계속 진행하기 전에 다음을 다운로드하여 설치해야 합니다. 포스트맨 도구. 또한 무료 계정을 만들어야 합니다.
동기화 게이트웨이 포스트맨 컬렉션 가져오기
동기화 게이트웨이와 함께 Postman 사용을 시작하는 방법은 매우 간단합니다.
- 먼저, GitHub 리포지토리에서 동기화 게이트웨이 포스트맨 컬렉션을 다운로드합니다.
|
1 |
git 복제 https://github.com/couchbaselabs/Couchbase-Sync-Gateway-Postman-Collection.git |
- 여기에 설명된 지침을 따르세요. 소개 게시물 을 클릭해 컬렉션과 환경 파일을 Postman으로 가져옵니다. 설정이 끝나면 다음과 같이 보일 것입니다.
모의 요청 실행
사용자 환경에서 동기화 게이트웨이를 실행하지 않고도 Postman으로 동기화 게이트웨이 API를 테스트할 수 있습니다. 무료 계정으로 할 수 있는 모의 통화 횟수에는 제한이 있다는 점에 유의하세요. 따라서 이 기능을 광범위하게 사용할 계획이라면 프로 버전의 도구로 이동해야 할 수도 있습니다.
모의 동기화 게이트웨이 만들기
- 지침을 따르세요. 여기 을 클릭하여 모의 서버를 추가합니다. 말 그대로 버튼 클릭 한 번으로 모의 서버를 생성할 수 있습니다.
- 동기화 게이트웨이 포스트맨 환경 변수를 살펴봅니다. "관리자"는 관리자 URL 엔드포인트를 가리키고 "publicurl"는 공개 URL 엔드포인트를 가리킵니다. 새로 생성된 모의 서버를 가리키도록 다음 변수를 업데이트합니다.
- 이제 끝났습니다! 모의 서버에 대해 요청을 실행할 준비가 되었습니다.
다음은 모의 동기화 게이트웨이 서버에 대해 Postman으로 요청을 실행하는 예입니다.
모의 우편물 배달원 응답은 어떻게 생성되며 우편물 배달원은 응답을 어떻게 캐시하나요?
동기화 게이트웨이 컬렉션에는 "예제" 폴더에서 찾을 수 있는 미리 작성된 응답이 함께 제공됩니다. 이 응답은 모의 서버에 대해 테스트할 때 반환됩니다. 요청을 실제로 실행하지 않고도 "예제" 폴더에 있는 샘플 응답을 참조로 사용할 수 있습니다.
우편 배달원 테스트
모든 요청에는 관련 테스트 스크립트가 있습니다. 테스트는 매우 간단하며 대부분 HTTP 상태 코드를 확인합니다. 이러한 테스트를 확장하여 응답을 보다 광범위하게 처리할 수 있습니다.
동기화 게이트웨이 인스턴스로 테스트
모의 테스트는 API 탐색과 초기 개발 단계에 유용하지만 실제 시스템을 대상으로 테스트하는 것과는 다릅니다!
- 아직 다운로드하지 않았다면 동기화 게이트웨이 인스턴스 및/또는 Couchbase Server를 다운로드하세요.
- 샘플이 있습니다. 동기화 게이트웨이 구성 파일 를 사용하여 이전에 가져온 것과 동일한 컬렉션 GitHub 리포지토리에서 사용할 수 있습니다. 샘플 구성 파일에 지정된 구성 값은 기본 환경 변수에 해당합니다. 따라서 환경 파일의 기본값을 사용하려면 샘플을 사용하여 동기화 게이트웨이를 시작하면 됩니다. 동기화 게이트웨이 구성 파일.
- "관리자" 및 "publicurl"를 사용하여 동기화 게이트웨이 배포의 관리자 및 공용 엔드포인트를 가리키도록 합니다.
- 다음과 다른 구성 파일로 동기화 게이트웨이를 시작한 경우 샘플 동기화 게이트웨이 구성 파일을 업데이트하는 것 외에도 "관리자" 및 "publicurl" 변수를 변경하려면 다른 관련 환경 변수를 구성에 맞게 업데이트해야 합니다. 그 중 일부는 다음과 같습니다. "db", "name", "비밀번호" 그리고 "doc"
이제 라이브 시스템에서 테스트할 준비가 되었습니다!
요청 연결
컬렉션에서 지원하는 멋진 기능 중 하나는 요청 연쇄, 즉 요청의 출력을 후속 요청의 입력으로 사용할 수 있는 기능입니다. 이는 요청을 수동으로 편집할 필요 없이 요청 실행 결과로 환경 변수를 동적으로 업데이트하여 수행됩니다.
예를 들어
- 문서를 만들면 새 문서 리비전이 생성되고 새로 생성된 리비전의 리비전ID가 응답에 반환됩니다. "_rev" 필드에 추가합니다. 이 테스트에는 "_rev" 값을 설정하고 "rev" 환경 변수를 설정합니다.
- 이후 문서 업데이트를 요청하려면 요청에 개정ID를 지정해야 합니다. 이 값은 이전 실행 요청의 결과로 채워진 "rev" 환경 변수에서 검색됩니다.
클라이언트 포스트맨 코드 스니펫
Postman 클라이언트를 사용할 때 유용한 또 다른 기능은 "코드 조각 생성기"입니다. 지원되는 여러 언어 중 하나로 요청에 해당하는 코드 스니펫을 생성할 수 있습니다.
포스트맨 문서 생성기
API 문서에서 카우치베이스 개발자 포털 를 진실의 원천으로 간주해야 합니다.
그러나 컬렉션에 해당하는 Postman에서 생성한 문서의 '웹 버전'을 보려면 이 옵션을 선택하세요. '웹에서 보기' 옵션을 선택하면 됩니다. 로컬 포스트맨 클라이언트가 온라인 포스트맨 계정과 '동기화'되어 있어야 한다는 점에 유의하세요.
생성된 문서는 이와 비슷하게 보일 것입니다. 문서를 보려면 Postman에 계정이 있어야 합니다.
다음 단계
컬렉션 정의에서 문제를 발견하거나 추가 테스트를 통해 컬렉션을 개선하고 싶으시면 Github 리포지토리에 풀 리퀘스트를 제출해 주세요.
질문이나 피드백이 있으면 아래에 댓글을 남기거나 트위터로 언제든지 문의해 주세요. @rajagp 또는 이메일을 보내주세요. priya.rajagopal@couchbase.com. . 카우치베이스 포럼 를 통해 질문할 수 있습니다.
