{"id":6669,"date":"2019-04-15T07:26:38","date_gmt":"2019-04-15T14:26:38","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=6669"},"modified":"2019-05-17T12:35:20","modified_gmt":"2019-05-17T19:35:20","slug":"generating-couchbase-api-dreamfactory","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/generating-couchbase-api-dreamfactory\/","title":{"rendered":"Generaci\u00f3n de APIs Couchbase con DreamFactory"},"content":{"rendered":"

Este es un art\u00edculo escrito por W. Jason Gilmore (https:\/\/www.wjgilmore.com<\/a>) es el Director T\u00e9cnico de DreamFactory, Inc, una plataforma de c\u00f3digo abierto de automatizaci\u00f3n y gesti\u00f3n de API. Antes de unirse a DreamFactory, pas\u00f3 gran parte de su carrera como consultor y desarrollador, ayudando a equipos de todo el mundo a crear soluciones de software incre\u00edbles. Jason es un prol\u00edfico escritor sobre tecnolog\u00edas web, con casi una docena de libros y m\u00e1s de 300 art\u00edculos en su haber. Es asesor t\u00e9cnico especial de varias empresas emergentes con sede en Ohio y Nueva York.<\/em><\/p>\r\n\r\n\r\n\r\n

\"Jason<\/figure>\r\n\r\n\r\n\r\n

Las organizaciones modernas est\u00e1n sometidas a una enorme presi\u00f3n para procesar e incorporar datos de forma eficaz a todas sus iniciativas. De hecho, el \u00e9nfasis que se pone en extraer, recopilar, analizar y difundir informaci\u00f3n es tal que se ha creado un campo de estudio completamente nuevo conocido como ciencia de datos<\/strong> para dar sentido a todo esto (para los que piensen que esto suena sospechosamente acad\u00e9mico, tomen nota de que Harvard Business Review llam\u00f3 a la ciencia de datos El trabajo m\u00e1s sexy del siglo XXI<\/a>.<\/p>\r\n\r\n\r\n\r\n

La necesidad de API<\/h2>\r\n\r\n\r\n\r\n

Adem\u00e1s de formalizar el proceso de gesti\u00f3n de datos, los equipos de TI han adoptado cada vez m\u00e1s los entornos de bases de datos heterog\u00e9neas y el desarrollo impulsado por API en un esfuerzo por garantizar que los datos se puedan ingerir, procesar y distribuir con la m\u00ednima fricci\u00f3n. Atr\u00e1s han quedado los d\u00edas en los que toda una organizaci\u00f3n se estandarizaba con un proveedor de bases de datos concreto; en su lugar, ahora es habitual que las empresas adopten una mezcla de soluciones SQL y NoSQL comerciales y de c\u00f3digo abierto.<\/p>\r\n\r\n\r\n\r\n

Por supuesto, debe haber alguna forma sensata de gestionar los datos a medida que fluyen a trav\u00e9s de estas bases de datos, y ah\u00ed es donde entran en juego las API. Dado que las bases de datos suelen consultarse desde distintas aplicaciones (iOS, web, etc.), en los \u00faltimos a\u00f1os los desarrolladores han preferido las API a las bibliotecas espec\u00edficas de las aplicaciones. Al crear una API uniforme y conectarse a ella, los desarrolladores pueden centrarse en la propia aplicaci\u00f3n en lugar de en la fontaner\u00eda relacionada con las bases de datos.<\/p>\r\n\r\n\r\n\r\n

Entra en DreamFactory<\/h2>\r\n\r\n\r\n\r\n

O al menos esa es la idea. La realidad es que crear y mantener una API de base de datos es una tarea extraordinariamente larga y costosa. Aunque un equipo experimentado puede crear una interfaz CRUD API en unas pocas semanas, a menudo no tiene en cuenta las numerosas funciones adicionales necesarias para la gesti\u00f3n de la API. Capacidades como la autenticaci\u00f3n y la autorizaci\u00f3n, la limitaci\u00f3n del volumen de solicitudes, el almacenamiento en cach\u00e9 y el registro no suelen tenerse en cuenta a la hora de planificar una API, y averiguar c\u00f3mo implementar estas capacidades de forma fragmentada puede resultar extraordinariamente dif\u00edcil y costoso.<\/p>\r\n\r\n\r\n\r\n

Muchas organizaciones evitan estos quebraderos de cabeza adoptando un Plataforma de gesti\u00f3n de API<\/strong>. Una soluci\u00f3n especialmente popular es DreamFactory<\/a>. No s\u00f3lo es de c\u00f3digo abierto (tambi\u00e9n hay disponibles versiones comerciales que ofrecen capacidades avanzadas), sino que tambi\u00e9n incluye soporte nativo para Couchbase. En este post aprender\u00e1s c\u00f3mo generar una API REST de Couchbase utilizando DreamFactory en cuesti\u00f3n de minutos, y luego bloquear el acceso a la API utilizando la funci\u00f3n de gesti\u00f3n de roles de DreamFactory.<\/p>\r\n\r\n\r\n\r\n

Presentamos DreamFactory<\/h2>\r\n\r\n\r\n\r\n

DreamFactory<\/a> es un marco de automatizaci\u00f3n y gesti\u00f3n de API utilizado por decenas de miles de organizaciones de todo el mundo. Aunque su popularidad se debe en gran medida a la capacidad de generar API completas, documentadas y seguras para una gran variedad de bases de datos SQL y NoSQL sin necesidad de codificaci\u00f3n, DreamFactory admite en realidad miles de fuentes de datos y servicios de terceros, incluidos proveedores de entrega de correo electr\u00f3nico, servicios de notificaci\u00f3n m\u00f3vil como AWS SNS, Apple y GCM Push, y para convertir servicios SOAP a REST.<\/p>\r\n\r\n\r\n\r\n

DreamFactory soporta un total de 18 bases de datos, incluyendo MySQL, Oracle, Microsoft SQL Server, y... \u00a1Couchbase! Generar una API es muy sencillo, s\u00f3lo requiere proporcionar el nombre de API deseado y las credenciales del servidor Couchbase. Para crear una API, usted comenzar\u00e1 ingresando a la interfaz de administraci\u00f3n web de DreamFactory. Podr\u00e1 acceder a las caracter\u00edsticas clave de DreamFactory a trav\u00e9s de la barra de navegaci\u00f3n:<\/p>\r\n\r\n\r\n\r\n

\"DreamFactory<\/figure>\r\n\r\n\r\n\r\n

Cree el servicio haciendo clic en Servicios<\/code> entonces Cree<\/code>seleccione Couchbase<\/code> del Base de datos<\/code> categor\u00eda:<\/p>\r\n\r\n\r\n\r\n

\"Select<\/figure>\r\n\r\n\r\n\r\n

A continuaci\u00f3n elegir\u00e1s un nombre para la API y establecer\u00e1s una etiqueta y una descripci\u00f3n. El nombre es especialmente importante porque, como ver\u00e1s, servir\u00e1 como espacio de nombres para la API generada. La etiqueta y la descripci\u00f3n son s\u00f3lo para fines de referencia dentro de la interfaz de administraci\u00f3n:<\/p>\r\n\r\n\r\n\r\n

\"Couchbase<\/figure>\r\n\r\n\r\n\r\n

Despu\u00e9s de rellenar estos campos, haga clic en el bot\u00f3n Configurar<\/code> e introduzca sus credenciales de Couchbase:<\/p>\r\n\r\n\r\n\r\n

\"Completed<\/figure>\r\n\r\n\r\n\r\n

Adem\u00e1s del Anfitri\u00f3n<\/code>, Puerto<\/code>, Nombre de usuario<\/code> y Contrase\u00f1a<\/code> puede limitar opcionalmente el n\u00famero de registros devueltos por un campo GET<\/code> y habilitar el almacenamiento de datos en cach\u00e9 durante un periodo de tiempo determinado. Para los prop\u00f3sitos de este tutorial voy a dejar esas opciones sin tocar y s\u00f3lo generar la API pulsando el bot\u00f3n Guardar<\/code> bot\u00f3n.<\/p>\r\n\r\n\r\n\r\n

Interacci\u00f3n con la API<\/h2>\r\n\r\n\r\n\r\n

Una vez generada la API, puede navegar a la p\u00e1gina Documentos API<\/code> para experimentar con ella. DreamFactory genera documentaci\u00f3n Swagger para cada API, y los administradores pueden proporcionar a los usuarios acceso restringido a esta documentaci\u00f3n. Seleccione la nueva API, y se le presentar\u00e1 una lista de todos los puntos finales disponibles:<\/p>\r\n\r\n\r\n\r\n

\"API<\/figure>\r\n\r\n\r\n\r\n

Elija el GET \/_esquema<\/code> y pulse la tecla Pru\u00e9balo<\/code> bot\u00f3n. Dado que la documentaci\u00f3n de Swagger es interactiva, puedes aprender c\u00f3mo funciona la API sin tener que saltar directamente al c\u00f3digo, lo que puede disminuir enormemente la frustraci\u00f3n. Pulsando Pru\u00e9balo<\/code> habilitar\u00e1 los distintos campos de par\u00e1metros asociados a este endpoint:<\/p>\r\n\r\n\r\n\r\n

\"Detailed<\/figure>\r\n\r\n\r\n\r\n

NOTA: Debido a la amplitud de bases de datos soportadas, y la importancia de proveer una interfaz API de base de datos uniforme sin importar el tipo de base de datos subyacente, DreamFactory utiliza t\u00e9rminos gen\u00e9ricos para referirse a estructuras relacionadas con bases de datos. L\u00f3gicamente, estos t\u00e9rminos no siempre se corresponden exactamente con la terminolog\u00eda espec\u00edfica de la base de datos. Por ejemplo, Couchbase utiliza el t\u00e9rmino cubo<\/strong> para representar una base de datos, mientras que DreamFactory utiliza el t\u00e9rmino gen\u00e9rico esquema<\/strong> para esta representaci\u00f3n.<\/em><\/p>\r\n\r\n\r\n\r\n

Pulse el bot\u00f3n Ejecute<\/code> y se consultar\u00e1 el punto final de la API, devolviendo todos los buckets disponibles. Los usuarios de Couchbase estar\u00e1n familiarizados con la funci\u00f3n viaje-muestra<\/code> devuelto en la siguiente respuesta:<\/p>\r\n\r\n\r\n\r\n

\"Example<\/figure>\r\n\r\n\r\n\r\n

Acceso a los datos de la API<\/h2>\r\n\r\n\r\n\r\n

A continuaci\u00f3n, despl\u00e1cese hasta GET \/_tabla\/{nombre_tabla}<\/code> para recuperar registros (documentos) de la base de datos viaje-muestra<\/code> cubo. El proceso para hacerlo es similar al utilizado para recuperar los buckets; seleccionar\u00e1s el endpoint, pulsar\u00e1s Pru\u00e9balo<\/code>y, a continuaci\u00f3n, introduzca los par\u00e1metros del punto final de la API que desee. Como puede ver en la siguiente captura de pantalla, este punto final admite bastantes par\u00e1metros:<\/p>\r\n\r\n\r\n\r\n

\"API<\/figure>\r\n\r\n\r\n\r\n

Cuando se trata de seleccionar registros, DreamFactory soporta todo lo que usted har\u00eda t\u00edpicamente al consultar una base de datos. Puede seleccionar campos espec\u00edficos, unir tablas, filtrar registros, aplicar l\u00edmites y desplazamientos, etc. Para este ejemplo, manteng\u00e1moslo simple y despl\u00e1cese hasta la parte inferior de la lista de par\u00e1metros e ingrese viaje-muestra<\/code> en el nombre_tabla<\/code> par\u00e1metro. Pulse Ejecute<\/code> y ver\u00e1s los siguientes resultados:<\/p>\r\n\r\n\r\n\r\n

\"Couchbase<\/figure>\r\n\r\n\r\n\r\n

Generaci\u00f3n de una clave de API restringida<\/h2>\r\n\r\n\r\n\r\n

La interfaz API Docs es estupenda para aprender m\u00e1s sobre el funcionamiento de una API, aunque inevitablemente querr\u00e1 empezar a consultar la API desde una aplicaci\u00f3n web o m\u00f3vil. Para ello, primero tendr\u00e1 que generar un archivo Clave API<\/strong>. Esto se debe a que DreamFactory no admite el concepto de API p\u00fablica; todas las API est\u00e1n protegidas por una clave de API como m\u00ednimo. Adem\u00e1s, cada clave de API se asigna a un papel<\/strong>. Los roles de DreamFactory determinan lo que un cliente en posesi\u00f3n de una clave API puede hacer en conjunci\u00f3n con la API. Por ejemplo, puede crear un rol que sea de s\u00f3lo lectura, o que s\u00f3lo permita el acceso a una tabla espec\u00edfica de la base de datos, o que s\u00f3lo pueda insertar registros en una tabla pero leer registros de otra tabla.<\/p>\r\n\r\n\r\n\r\n

Para crear una funci\u00f3n, vaya a la secci\u00f3n Funciones<\/code> y pulse Cree<\/code>. Asignar\u00e1 un nombre y una descripci\u00f3n a la funci\u00f3n y, a continuaci\u00f3n, har\u00e1 clic en el bot\u00f3n Acceda a<\/code> pesta\u00f1a. Es aqu\u00ed donde ocurre la magia. En la siguiente captura de pantalla ver\u00e1s que he seleccionado la opci\u00f3n couchbase<\/code> API (servicio), y establezca Componente<\/code> a _table\/travel-sample\/*<\/code>lo que significa que el rol s\u00f3lo puede acceder a este conjunto de datos en particular. Adem\u00e1s, he establecido Acceda a<\/code> a GET<\/code>lo que significa que ser\u00e1 un rol de s\u00f3lo lectura:<\/p>\r\n\r\n\r\n\r\n

\"Create<\/figure>\r\n\r\n\r\n\r\n

Hay algunas otras caracter\u00edsticas interesantes aqu\u00ed, sin embargo en aras de la brevedad le sugiero s\u00f3lo pulsando Guardar<\/code> para generar el rol.<\/p>\r\n\r\n\r\n\r\n

A continuaci\u00f3n, haga clic en el bot\u00f3n Aplicaciones<\/code> para generar una clave API. Pulse el bot\u00f3n Cree<\/code> y aparecer\u00e1 la siguiente interfaz:<\/p>\r\n\r\n\r\n\r\n

\"Create<\/figure>\r\n\r\n\r\n\r\n

Aqu\u00ed tendr\u00e1s que introducir el nombre y la descripci\u00f3n de la aplicaci\u00f3n. Tambi\u00e9n elegir\u00e1s una funci\u00f3n para esta clave API, y en este ejemplo he seleccionado la reci\u00e9n generada couchbase<\/code> papel. Por \u00faltimo, para el Ubicaci\u00f3n de la aplicaci\u00f3n<\/code> He seleccionado No requiere almacenamiento<\/code> porque me conectar\u00e9 a la API desde una ubicaci\u00f3n remota, como una aplicaci\u00f3n web. Pulse Guardar<\/code> y volver\u00e1s al listado de claves de la aplicaci\u00f3n:<\/p>\r\n\r\n\r\n\r\n

\"Create<\/figure>\r\n\r\n\r\n\r\n

Enhorabuena, acabas de crear una clave API restringida de s\u00f3lo lectura. Ahora vamos a usar esa clave para hablar con el bucket de Couchbase.<\/p>\r\n\r\n\r\n\r\n

Conexi\u00f3n a su API<\/h2>\r\n\r\n\r\n\r\n

Con su clave de API en la mano, es hora de interactuar con la API desde fuera de la interfaz de DreamFactory. Para los prop\u00f3sitos de este ejemplo voy a utilizar el comando Cliente REST de Insomnia<\/a> no obstante, puede utilizar Cartero<\/a>o con otro cliente API, o tambi\u00e9n puedes crear una sencilla interfaz web o para iPhone. En la siguiente captura de pantalla he consultado la \/api\/v2\/couchbase\/_table\/viaje-muestra<\/code> y en la parte derecha de la interfaz podr\u00e1 ver los resultados:<\/p>\r\n\r\n\r\n\r\n

\"Using<\/figure>\r\n\r\n\r\n\r\n

De particular importancia es la X-DreamFactory-Api-Key<\/code> \u00a1cabecera! Es aqu\u00ed donde se proporciona la clave API. Si no se proporciona la clave, se producir\u00e1 un error del tipo 400<\/code> con un mensaje de error relativo a una clave que falta. Adem\u00e1s, si esta clave intenta acceder a una tabla restringida o realizar una acci\u00f3n (insertar, actualizar, etc.) que no se ha permitido expresamente en la definici\u00f3n de la funci\u00f3n, aparecer\u00e1 un mensaje de error del tipo 401<\/code> se devolver\u00e1 un c\u00f3digo de estado no autorizado.<\/p>\r\n\r\n\r\n\r\n

Recursos<\/h2>\r\n\r\n\r\n\r\n

Esperemos que esta introducci\u00f3n a DreamFactory te haya hecho pensar en lo r\u00e1pido que puedes empezar a crear aplicaciones basadas en Couchbase. Si est\u00e1s interesado en aprender m\u00e1s, los siguientes recursos te ser\u00e1n de utilidad:<\/p>\r\n\r\n\r\n\r\n