Consulta ao Couchbase Sync Gateway usando o Postman

Esta postagem discute uma maneira conveniente de consultar, explorar e testar a API REST exposta pelo Couchbase Mobile Sync Gateway usando a ferramenta Postman Chrome Developer. O Sync Gateway expõe uma interface REST, Batch & Stream que permite que os clientes interajam com ele pela Internet.

OBSERVAÇÃO: discutiremos o Couchbase Mobile v1.4, que é a versão de produção atual. Há uma versão mais recente Versão 2.0 do Developer Preview do Couchbase Mobile

Histórico

O Couchbase Sync Gateway faz parte do Couchbase Mobile e é um mecanismo de sincronização voltado para a Internet que sincroniza com segurança os dados entre dispositivos, bem como entre dispositivos e a nuvem. Há duas portas pelas quais o Sync Gateway escuta as solicitações: a porta Admin (padrão 4985) e a porta Pública (padrão 4984). Em implantações de produção, a porta de administrador é normalmente bloqueada para acesso pela Internet.

Instalação do Couchbase Sync Gateway

Siga as instruções na postagem do blog para instalar o Sync Gateway em seu ambiente de desenvolvimento do Mac OS. Veja a downloads para todos os pacotes disponíveis, e o site guia de instalação completo para obter detalhes completos. Para instalar em distribuições Linux que não sejam as suportadas, consulte esta postagem.

Instalação do Postman

Carteiro é uma ferramenta para desenvolvedores do Chrome que pode ser baixada gratuitamente no site Loja virtual do navegador Chrome .

Usando o Postman para consultar o Couchbase Sync Gateway

• Obter as coleções do Postman

Os arquivos de coleção do Postman e a definição de ambiente para a interface Admin e Public do Sync Gateway estão disponíveis para download em Repositório do Github.

Deve haver três arquivos

Sync-Gateway-Admin.postman_collection 

Esta é a coleção Portman correspondente à interface de administração do Sync Gateway

Sync-Gateway-Public.postman_collection

Esta é a coleção Portman correspondente à interface pública do Sync Gateway

Sync-Gateway-Environment.postman_environment

Este é o arquivo Environment Definitions que define as variáveis usadas pelas coleções Admin e Public

Iniciar o aplicativo Postman

• Importar as coleções

Siga as etapas do vídeo abaixo para importar as coleções que foram baixadas na etapa anterior.

Importação de coleções do postman do gateway de sincronização

• Importar o arquivo de ambiente

Siga as etapas do vídeo abaixo para importar a definição de ambiente correspondente às coleções do Postman

• Defina o ambiente adequado

Siga as etapas do vídeo abaixo para definir o ambiente como o que você acabou de importar. Atualize os valores das variáveis de acordo com seu ambiente. Certifique-se de que a variável adminurl aponta para o Gateway de sincronização na porta de administração e o publicurl aponta para o Sync Gateway na porta pública. Seu padrão é https://localhost:4985 e https://localhost:4984 respectivamente.

• É isso aí! Execute suas consultas

A seguir, uma demonstração da execução de uma solicitação na interface de administração

A seguir, uma demonstração da execução de uma solicitação na interface pública. Certifique-se de que o cabeçalho de autorização esteja definido adequadamente para usar o mecanismo de autenticação apropriado.

Consulta à interface pública do Sync Gateway

Opção de CLI

Se você estiver interessado em executar a Postman Collection a partir da interface de linha de comando, o que pode ser o caso, por exemplo, se quiser integrá-la como parte do seu processo de integração contínua, consulte  Newmanque é um executor CLI para o Postman.

Por exemplo, o comando abaixo executará o Sync-Gateway-Admin.postman_collection com o arquivo Sync-Gateway-Environment.

Se o Sync Gateway estiver sendo executado com o SSL ativado e estiver usando um certificado autoassinado, a opção "-k" suprimirá a validação do certificado (conexão SSL "insegura"). Isso não é recomendado em ambientes de produção.

Próximas etapas

As coleções Postman oferecem uma maneira fácil de consultar, explorar e testar a interface REST exposta pelo Sync Gateway. Se você encontrar um problema nas definições das coleções ou se quiser aprimorá-las, envie uma solicitação pull para a seção Repositório do Github.

Se tiver mais perguntas, sinta-se à vontade para entrar em contato comigo pelo Twitter @rajagp ou envie-me um e-mail priya.rajagopal@couchbase.com.

O Fóruns de desenvolvimento do Couchbase Mobile é outro ótimo lugar para obter respostas para suas perguntas relacionadas a dispositivos móveis.

Além disso, dê uma olhada no Couchbase Definições da API do gateway de sincronização para obter detalhes sobre a interface da Web.