Los endpoints son una parte esencial de los procesos de negocio y del desarrollo de aplicaciones en general. En este artículo, definimos qué son los endpoints, por qué los necesitamos y cómo crearlos en la plataforma AppMaster.
¿Qué es un endpoint?
Un endpoint es una pasarela que conecta los procesos del servidor de la aplicación con una interfaz externa. En otras palabras, es la dirección a la que se envían las peticiones.
Es importante mencionar cómo funciona la API para entender qué son los endpoints. API es la abreviatura de una interfaz de programación de aplicaciones. Las aplicaciones utilizan las API para interactuar con servicios de terceros y sus usuarios.
Para conectarse a la API, es necesario enviar una solicitud. Para el correcto procesamiento de la solicitud, el cliente debe proporcionar un puntero universal de recursos (URL), un método HTTP y, dependiendo del método, añadir cabeceras, cuerpo y parámetros de solicitud. Las cabeceras proporcionan metadatos sobre la solicitud, mientras que el cuerpo contiene datos, como los campos de las nuevas filas de la base de datos.
La API procesará la solicitud y enviará la respuesta recibida del servidor. La respuesta contendrá un código de estado, que es una parte del mensaje de respuesta HTTP que informa al cliente del resultado de la solicitud. Por ejemplo, el código 200 se utiliza si la operación se ha completado con éxito, 500 si se ha producido un error interno del servidor.
Los endpoints funcionan junto con los métodos de la API. Son URLs específicas que la aplicación utiliza para comunicarse con servicios de terceros y con sus usuarios. Una URL es una ruta que puede manejar diferentes métodos de solicitud. Cada tipo de petición es un endpoint distinto. Hay cinco tipos principales:
- GET - obtiene información del servidor; no requiere un cuerpo de petición;
- POST - crea un nuevo objeto en la base de datos, requiere un cuerpo de petición con los campos de este objeto;
- PUT - restablece completamente un objeto específico en la base de datos;
- PATCH - similar a PUT, restablece un objeto específico en la base de datos, pero sólo actualizará los campos que se mencionan en el cuerpo de la petición;
- DELETE - elimina el objeto de la base de datos.
Cuando se crea una petición específica, se le pueden añadir varios parámetros. La combinación de estos parámetros y la URL representa un URI - Uniform Resource Identifier (identificador de recursos uniforme). Indica dónde y cómo encontrar el recurso.
¿Cómo puede configurar los endpoints en la plataforma AppMaster.io?
En la sección Endpoints de la plataforma AppMaster.io, puede ver todos los endpoints generados automáticamente y los endpoints de su proyecto. Si la autogeneración de pantallas y páginas en su proyecto está activada, se crearán automáticamente los endpoints correspondientes para cualquier modelo de datos creado. También, los endpoints pueden ser creados automáticamente al instalar algunos módulos, por ejemplo, Autorización (Auth), Países y ciudades, y otros.
AppMaster.io permite trabajar con varios tipos de APIs de endpoints:
- API para acceder al backend desde el cliente y sistemas de terceros;
- webhooks para recibir notificaciones de sistemas de terceros;
- WebSockets, para abrir una sesión de comunicación interactiva bidireccional entre un navegador y un servidor sin pedir al servidor una respuesta.
Todos los endpoints están agrupados. Dentro de cada grupo, encontrará todos los puntos finales correspondientes, sus tipos de solicitud, las URL y los procesos empresariales a los que están conectados. Todos los puntos finales pueden ser eliminados y editados por usted.
Al crear o editar un punto final, las siguientes opciones están disponibles en la ventana de configuración:
- Método de solicitud. GET, POST, PUT, DELETE o PATCH.
- Red de petición. La primera parte con la ruta al servidor no se especifica ya que es la misma para todos los endpoints de la aplicación. Es suficiente con establecer el final, por ejemplo, /users. Aquí también se especifica el parámetro de la URL. Supongamos que el endpoint está diseñado para recibir información sobre un usuario específico. En ese caso, hay que escribir su ID después de ":" (/users/:id) y pasarlo como parámetro.
- Grupos de endpoints. Este parámetro tiene como objetivo organizar y estructurar el trabajo con los endpoints. Todos los endpoints se pueden dividir en grupos (carpetas).
- Proceso de negocio. Uno de los parámetros más críticos que determinan lo que hará el endpoint. Al mismo tiempo, el propio endpoint puede permanecer sin cambios. Recibirá todas las mismas peticiones en la dirección antigua, y si el proceso de negocio se sustituye, realizará una función diferente. Los procesos de negocio para las operaciones básicas de la base de datos se crean automáticamente. Usted no puede editarlos, pero si es necesario, puede reemplazarlos con BPs personalizados.
También puede configurar middleware. El middleware es un software intermediario que sirve de filtro al procesar las peticiones de la aplicación. El middleware se utiliza para comprobar cualquier condición antes de ejecutar una solicitud. Por ejemplo, si creas un middleware para comprobar la autenticación del usuario, el middleware redirigirá al usuario a la página de inicio de sesión si el usuario no ha iniciado la sesión. Si ha iniciado la sesión, el middleware no interferirá en el procesamiento de la solicitud, pasándola al cliente.
Crear un endpoint en AppMaster.io
Vamos a considerar la configuración de endpoints en la práctica y a analizarla a través del ejemplo del proyecto Aviato. Puede encontrar el proceso completo de creación de este proyecto en el curso de AppMaster.io.
Dentro del proyecto, creamos dos procesos de negocio:
- Validar y crear vuelos - el proceso que se utilizará para sustituir el proceso de negocio Crear vuelo;
- Registrar pasajero - para registrar un pasajero en un vuelo específico.
Ahora podemos utilizar estos procesos para configurar endpoints en el proyecto.
Empecemos con el proceso de negocio Validar y crear vuelos. El grupo de vuelos ya tiene un endpoint POST/flights para crear un vuelo. Ahora necesitamos reemplazar el proceso de negocio adjunto por uno nuevo. Para hacer esto, necesitamos editar el endpoint.
En la ventana de configuración, seleccione el proceso de negocio deseado. En nuestro caso, se trata de un BP de Validación y creación de vuelos. Después de eso, tenemos que seleccionar todas las variables de entrada necesarias y guardar los cambios.
Ahora podemos configurar el siguiente endpoint para el proceso de negocio Register passenger.
Nuestro objetivo es crear una sección para ver un vuelo específico y los pasajeros asociados a él y configurar un proceso para registrar nuevos pasajeros.
En el grupo de endpoints Flights, necesitamos crear un nuevo endpoint: /flights/:id/register, donde id hace referencia a un vuelo concreto que podemos utilizar como entrada en un proceso de negocio.
Pulsando sobre el icono del Plus, podemos añadir un nuevo endpoint. El método de petición será POST ya que estamos creando un nuevo objeto. Seleccionamos el proceso de registro de pasajeros para nuestro BP y guardamos todos los cambios realizados.
Así de fácil es crear endpoints en la plataforma AppMaster.io. Videotutorial completo:
Conclusión
Los endpoints juegan un papel vital en el funcionamiento de la API que, a su vez, es necesaria para la ampliación de proyectos y la cómoda integración de servicios y aplicaciones. La plataforma sin código AppMaster.io facilita el trabajo con los endpoints, creándolos y configurándolos. Siempre se puede registrar en la plataforma y comprobar toda la funcionalidad.
