Couchbase incorporado Swagger en nuestra documentación hace unos meses. "Swagger" hace referencia a un ecosistema de herramientas y otros recursos para gestionar API REST.
El núcleo de Swagger es el Especificación Swagger. (El grupo detrás de Swagger donó la especificación a la Iniciativa OpenAPI. El sitio original, swagger.io sigue siendo el sitio principal para herramientas y demás).
Una vez definida la especificación de la API para los puntos finales, se obtienen varias funciones valiosas. Mis dos favoritas son la documentación integrable "en vivo" y las bibliotecas de clientes. Echa un vistazo a este breve vídeo para ver una demostración de algunas de las características de Swagger.
[youtube https://www.youtube.com/watch?v=0UWiE-c9Nds&w=560&h=315]
Para ver un ejemplo de uso de un cliente JavaScript Swagger, eche un vistazo a esta entrada de blog: https://www.couchbase.com/blog/node-js-swagger-monitor-document-changes-couchbase-mobile/
Puede encontrar las especificaciones Swagger para la API pública de Sync Gateway aquíy la API de administración aquí.
Aquí están las configuraciones de Sync Gateway a las que me refiero en el vídeo. La primera tiene la configuración CORS para permitir el acceso desde swagger.io.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ "log": ["*"], "CORS": { "Origin":["*"], "Headers": ["Content-Type"] }, "databases": { "db": { "server": "walrus:", "users": { "GUEST": { "disabled": false, "admin_channels": ["*"] } }, "allow_empty_password": true } } } |
La segunda es para probar las llamadas a través de nuestra documentación en directo.
|
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": { "Origin": ["*"], "Headers": ["Content-Type"] }, "databases": { "db": { "server": "walrus:", "users": { "GUEST": { "disabled":false, "admin_channels": [ "*" ] } } } } } |
(Nota: Actualmente existe un problema conocido al realizar las llamadas desde la documentación de Couchbase. Couchbase ahora requiere el acceso a través de https, de acuerdo con las mejores prácticas de seguridad. Esto significa que la documentación también redirige usando https. Esto significa que usted tiene que configurar Sync Gateway para utilizar SSL. Ver la documentación aquí para más información).
Posdata
Descargar Couchbase y Sync Gateway aquí. Consulte nuestro documentación para saber cómo añadir Couchbase Lite a un proyecto.
Consulte más recursos en nuestra portal para desarrolladores y síganos en Twitter @CouchbaseDev.
Puede enviar preguntas a nuestro foros. Y participamos activamente en Stack Overflow.
Envíame tus preguntas, comentarios, temas que te gustaría ver, etc. a Twitter. @HodGreeley
