Couchbase incorporado Swagger em nossa documentação há alguns meses. "Swagger" refere-se a um ecossistema de ferramentas e outros recursos para gerenciar APIs REST.
O núcleo do Swagger é o Especificação do Swagger. (O grupo por trás do Swagger doou as especificações para o Iniciativa OpenAPI. O site original, swagger.io continua sendo o site principal para ferramentas e afins).
Depois de definir a especificação da API para seus pontos de extremidade, você obtém vários recursos valiosos. Meus dois favoritos são a documentação incorporável "ao vivo" e as bibliotecas de clientes. Dê uma olhada neste vídeo curto para ver uma demonstração de alguns dos recursos do Swagger.
[youtube https://www.youtube.com/watch?v=0UWiE-c9Nds&w=560&h=315]
Para ver um exemplo de uso de um cliente JavaScript Swagger, dê uma olhada nesta publicação do blog: https://www.couchbase.com/blog/node-js-swagger-monitor-document-changes-couchbase-mobile/
Você pode encontrar as especificações Swagger para a API pública do Sync Gateway aquie a API de administração aqui.
Aqui estão as configurações do Sync Gateway às quais me refiro no vídeo. A primeira tem a configuração CORS para permitir o acesso a partir do swagger.io.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ "log": ["*"], "CORS": { "Origem":["*"], "Headers" (Cabeçalhos): ["Content-Type"] }, "bancos de dados": { "db": { "servidor": "walrus:", "usuários": { "CONVIDADO": { "desativado": falso, "admin_channels": ["*"] } }, "allow_empty_password" (permitir senha vazia): verdadeiro } } } |
A segunda é para testar chamadas por meio de nossa documentação ao vivo.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ "log": [ "*" ], "SSLCert": "cert.pem", "SSLKey": "privkey.pem", "CORS": { "Origem": ["*"], "Headers" (Cabeçalhos): ["Content-Type"] }, "bancos de dados": { "db": { "servidor": "walrus:", "usuários": { "CONVIDADO": { "desativado":falso, "admin_channels": [ "*" ] } } } } } |
(Observação: no momento, há um problema conhecido ao fazer as chamadas da documentação do Couchbase. O Couchbase agora exige acesso via https, de acordo com as práticas recomendadas de segurança. Isso significa que a documentação também redireciona usando https. Isso significa que você precisa configurar o Sync Gateway para usar SSL. Veja a documentação aqui para obter mais informações).
Pós-escrito
Download do Couchbase e do Sync Gateway aqui. Veja nosso documentação para saber como adicionar o Couchbase Lite a um projeto.
Confira mais recursos em nosso portal do desenvolvedor e nos siga no Twitter @CouchbaseDev.
Você pode postar perguntas em nosso fóruns. E participamos ativamente de Estouro de pilha.
Entre em contato comigo pelo Twitter com perguntas, comentários, tópicos que você gostaria de ver etc. @HodGreeley
