Este artículo le mostrará cómo trabajar con API en nuestra plataforma sin código de nivel profesional, AppMaster.io. Pero, primero, recordemos algunos datos básicos sobre la API.
Introducción
API significa interfaz de programación de aplicaciones. Así es como el cliente y el servidor pueden comunicarse entre sí. El cliente y el servidor envían solicitudes y respuestas, y la API actúa como intermediario entre ellos.
Esta interacción cliente-servidor debe ser simple, comprensible y conveniente. Simplifica tanto las tareas de los desarrolladores (no es necesario reinventar un nuevo servicio) como las de los usuarios (un servicio es más fácil de aprender si funciona familiarmente). Hay varios tipos de API:
- API de servicios web, XML-RPC y JSON-RPC, SOAP;
- API de WebSockets;
- API basadas en biblioteca, Java Script;
- API basadas en clases, API de C#, Java.
En la plataforma AppMaster.io sin código, usamos el estilo REST API.
REST o la transferencia de estado representacional completa es el estilo arquitectónico de interacción (intercambio de información) entre el cliente y el servidor. Los servicios de la API REST se comunican mediante el protocolo HTTP.
El estilo REST tiene ciertas ventajas. La principal ventaja de REST es su excelente flexibilidad. REST consta de pautas simples que permiten a los desarrolladores implementar requisitos en su formato. REST tiene un alto rendimiento, lo cual es muy importante, por ejemplo, para una carga rápida en dispositivos móviles. Es por eso que todas las grandes empresas como Twitter y Google han implementado durante mucho tiempo la API REST para sus productos. Puede leer más sobre el trabajo y las principales ventajas de la API REST en nuestro artículo.
La estructura de cualquier solicitud incluye cinco componentes principales: método HTTP, puntos finales, encabezados y cuerpo, parámetros de la solicitud.
La API REST utiliza 4 métodos HTTP básicos para trabajar con un recurso (información), y cada uno de ellos describe lo que se debe hacer con el recurso:
- POST — creación de recursos;
- GET: obtener un recurso;
- PUT — actualización de recursos;
- DELETE: eliminación de un recurso.
Un recurso es cualquier información (documento, imagen, video, texto, etc.). En la plataforma sin código AppMaster.io, esta información se entrega al cliente en varios formatos, incluido el más común: JSON.
El punto final contiene un URI: identificador uniforme de recursos (identificador uniforme de recursos), que indica dónde y cómo encontrar un recurso en Internet e incluye una URL (URL o ubicación uniforme de recursos es una dirección web completa).
Los encabezados transmiten información tanto al cliente como al servidor. Los encabezados proporcionan principalmente datos de autenticación: una clave API, el nombre o dirección IP de la computadora en la que está instalado el servidor y el formato de respuesta.
El cuerpo es necesario para pasar información adicional al servidor: los datos del cuerpo son datos que, por ejemplo, desea agregar o reemplazar.
La documentación API para su aplicación en nuestra plataforma se genera automáticamente y se almacena en formato OpenAPI (Swagger) en su backend.
No necesita comprender con precisión cómo funciona para aprender a crear una API en AppMaster.io. Comprenderá los principios básicos aprendiendo sobre las herramientas de la plataforma. Además, la parte central de la API la crea AppMaster.io. La mayoría de los ajustes se realizan de forma predeterminada o al conectar módulos. Por ejemplo, nuestro módulo proporciona herramientas para la integración con API para correo.
Deberá realizar pequeños cambios en algunas configuraciones de API manualmente al integrar (conectar) su aplicación a otras aplicaciones o recursos externos. A continuación, veremos cómo hacer esto.
Creación de API utilizando la plataforma sin código AppMaster.io
Por lo tanto, puede encontrar la configuración de la API en varios lugares de nuestra plataforma.
Cómo crear un punto final de API en la plataforma sin código AppMaster.io
Inicie sesión en su cuenta para un proyecto existente.
Vaya al Diseñador de modelos de datos. En el Diseñador de modelos de datos, verá modelos con datos que desea procesar mediante la API de puntos finales. En cada proyecto, al principio, siempre hay un modelo por defecto, el Usuario. Si estás en un nuevo proyecto y aún no tienes tus modelos, créalos.
Asigne vínculos entre sus modelos y guarde el proyecto.
Vaya a la sección Endpoints en el menú de la izquierda de la pantalla.
Aquí verá una lista de todos sus puntos finales y los métodos REST API disponibles para ellos conectados a cada modelo en el campo del proyecto. Eliminará los métodos innecesarios y cambiará su configuración (icono de engranaje e icono de papelera de reciclaje).
Si no hay un punto final adecuado en la lista, puede crear uno nuevo haciendo clic en el botón Nuevo punto final y seleccionando el tipo apropiado. Se abrirá una ventana modal con la configuración de Endpoint.
Cómo crear una API externa en la plataforma sin código AppMaster.io
Vaya a la sección Lógica de negocios en el menú de la izquierda.
Aquí puede crear una solicitud de API externa en la pestaña Solicitud de API externa (esta opción está en versión beta).
Además, como mencionamos anteriormente, toda la documentación se genera automáticamente y se guarda en formato OpenAPI (Swagger) en el back-end de su aplicación.
Swagger es documentación y la capacidad de probar todos los puntos finales en el acto sin usar aplicaciones de terceros como Postman.
Conclusión
Como puede ver, crear y cambiar la configuración de la API sin código es muy simple y lleva un tiempo mínimo. Si aún no tiene una cuenta en AppMaster.io, únase a nosotros y regístrese para obtener una versión de prueba .
