Este post discute una manera conveniente de consultar, explorar y probar la API REST expuesta por Couchbase Mobile Sync Gateway usando la herramienta Postman Chrome Developer. Sync Gateway expone una interfaz REST, Batch & Stream que permite a los clientes interactuar con ella a través de Internet.
NOTA: Estaremos discutiendo Couchbase Mobile v1.4 que es la versión de producción actual. Existe una versión Vista previa para desarrolladores versión 2.0 de Couchbase Mobile
Fondo
Couchbase Sync Gateway forma parte de la plataforma Couchbase Móvil y es un mecanismo de sincronización a través de Internet que sincroniza datos de forma segura entre dispositivos, así como entre dispositivos y la nube. Hay dos puertos a través de los cuales la puerta de enlace de sincronización escucha las solicitudes: el puerto de administración (por defecto 4985) y el puerto público (por defecto 4984). En las implantaciones de producción, el puerto admin suele estar bloqueado para el acceso a través de Internet.
Instalación de Couchbase Sync Gateway
Siga las instrucciones de la entrada del blog para instale el Sync Gateway en su entorno de desarrollo Mac OS. Consulte la descargas para todos los paquetes disponibles, y el guía completa de instalación para más detalles. Para instalar en distribuciones de Linux distintas de las admitidas, consulte esta entrada.
Instalación de Postman
Cartero es una herramienta para desarrolladores de Chrome que puede descargarse gratuitamente de la página Tienda web del navegador Chrome .
Uso de Postman para consultar la pasarela de sincronización de Couchbase
-
Consigue las colecciones Cartero
Los archivos de recopilación de Postman y la definición del entorno para las interfaces Admin y Public de Sync Gateway pueden descargarse de esta dirección Repo Github.
|
1 |
git clonar https://github.com/couchbaselabs/Couchbase-Sincroniza-Pasarela-Cartero-Colección.git |
Debería haber tres archivos:-
Sync-Gateway-Admin.postman_collection
Esta es la colección de Portman correspondiente a la interfaz Admin de la Sync Gateway
Sync-Gateway-Public.postman_collection
Esta es la colección de Portman correspondiente a la interfaz pública de la pasarela de sincronización
Sync-Gateway-Environment.postman_environment
Este es el archivo de definiciones de entorno que define las variables utilizadas por las colecciones Admin y Public
Iniciar la aplicación Postman
-
Importar las colecciones
Siga los pasos del siguiente vídeo para importar las colecciones descargadas en el paso anterior.
Importación de colecciones postman de Sync gateway
-
Importar el archivo de entorno
Siga los pasos del siguiente vídeo para importar la definición de entorno correspondiente a las colecciones de Postman
-
Establecer el entorno adecuado
Sigue los pasos del siguiente vídeo para ajustar el entorno al que acabas de importar. Actualiza los valores de las variables para adaptarlas a tu entorno. Asegúrate de que el adminurl apunta a la Sync Gateway en Admin Port y el dirección pública apunta a la pasarela de sincronización en el puerto público. Por defecto es http://localhost:4985 y http://localhost:4984 respectivamente.
-
Ya está. Ejecute sus consultas
A continuación se muestra una demostración de la ejecución de una solicitud en la interfaz de administración
A continuación se muestra una demostración de cómo ejecutar una solicitud en la Interfaz Pública. Asegúrese de que la cabecera de autorización está configurada adecuadamente para utilizar el mecanismo de autenticación apropiado.
Consulta de la interfaz pública de Sync Gateway
Opción CLI
Si está interesado en ejecutar Postman Collection desde la interfaz de línea de comandos, lo que puede ser el caso, por ejemplo, si desea integrar esto como parte de su proceso de Integración Continua, entonces debería consultar Newmanque es un CLI runner para Postman.
Por ejemplo, el siguiente comando ejecutará Sync-Gateway-Admin.postman_collection con el archivo Sync-Gateway-Environment.
Si su Sync Gateway se ejecuta con SSL activado y utiliza un certificado autofirmado, la opción "-k" suprimirá la validación del certificado (conexión SSL "insegura"). Esto no se recomienda en entornos de producción.
|
1 |
newman ejecute -k Sincroniza-Pasarela-Admin.colección_cartero --medio ambiente Sincroniza-Pasarela-Medio ambiente.entorno_postman --fianza --retraso-solicitar 300; |
Próximos pasos
Las colecciones Postman ofrecen una forma sencilla de consultar, explorar y probar la interfaz REST expuesta por Sync Gateway. Si detecta algún problema en las definiciones de las colecciones o si desea mejorarlas, envíe una solicitud de extracción a la sección Repo Github.
Si tiene más preguntas, no dude en ponerse en contacto conmigo en Twitter @rajagp o envíeme un correo electrónico priya.rajagopal@couchbase.com.
En Foros de desarrollo de Couchbase Mobile es otro buen lugar para resolver tus dudas sobre móviles.
Además, echa un vistazo a Couchbase Definiciones de la API de Sync Gateway para más detalles sobre la interfaz web.
buen ejemplo, postman es una buena herramienta para entender Sync Gateway REST API, también es una buena herramienta de prueba para probar su lógica de negocio Sync Gateway.
Si te gusta CLI para ejecutar el caso de usuario de prueba, recomiendo [newman](https://github.com/postmanlabs/newman) para ejecutar postman collections, que es la herramienta que estoy utilizando para probar la lógica de mi pasarela de sincronización.
Quiero compartir unos pequeños consejos para usar newman para probar la lógica de la pasarela de sincronización:
añadir 300ms para -delay-request para evitar que la consulta _changes feed con "normal" y "since" devuelva resultados vacíos la primera vez.
Véase también https://github.com/couchbase/sync_gateway/issues/2452
Gracias. Buena observación. He añadido una sección sobre la opción CLI