Información general

El último módulo terminó con la creación del primer proceso de negocio. Hemos descubierto cómo crear la lógica del proceso, aceptar parámetros de entrada específicos, realizar cálculos y emitir una respuesta. Queda por responder a la pregunta principal. ¿Cómo activar el proceso de negocio creado y ponerlo en funcionamiento?

Para resolver este problema, se han previsto puntos finales - puntos clave de interacción con la aplicación. En los primeros módulos, ya hemos interactuado con APIs externas. Esto fue posible gracias a la presencia de endpoints. Estaban descritos en la documentación, y la leímos y entendimos qué método y qué URL es necesario enviar una solicitud para acceder a un recurso específico.

Para entenderlo, veamos la implementación de los endpoints con un ejemplo concreto. En el tercer módulo, se creó el modelo de base de datos. Al mismo tiempo, simultáneamente con la creación de las tablas, se crearon automáticamente los endpoints para interactuar con ellas. Vayamos a la sección de endpoints (en el panel de la izquierda) y veámoslos.

En el ejemplo de la tabla "city" con información sobre las ciudades, se puede ver que ya tiene 6 endpoints para operaciones básicas de datos.

• GET /city - obtener todos los datos de una tabla
• GET /city/:id - obtener datos sobre la ciudad con el id especificado
• POST /city - añadir un nuevo registro a la tabla
• PUT /city/:id - sustitución completa del registro con el id especificado en la tabla
• PATCH /city/:id - sustitución parcial de un registro con el id especificado en la tabla
• DELETE /city/:id - eliminar de la tabla un registro con el id especificado

Configuración general

Puede abrir la configuración de cada endpoint y estudiarla con más detalle. Por ejemplo, considere el endpoint GET /city/:id

La imagen que vemos es muy similar a la que ya hemos visto al crear una petición a APIs externas. En un caso, sólo hemos accedido a un endpoint ya preparado, y ahora estamos creando y configurando este endpoint nosotros mismos. Para configurarlo, debemos especificar:

1. Método de solicitud. En este ejemplo, se trata del método GET.
2. URL de la solicitud. La primera parte con la ruta al servidor no se especifica. Es la misma para todos los endpoints de la aplicación. Basta con especificar sólo la terminación (/city). Aquí también se especifica el parámetro URL. El endpoint está diseñado para recibir información sobre una ciudad en particular, por lo que su id escrito después de ":" se pasa como parámetro.
3. Endpoint Groups. Este parámetro no afecta en absoluto al funcionamiento del endpoint y está pensado únicamente para la comodidad de la organización. Todos los puntos finales pueden dividirse en grupos temáticos (carpetas). En este ejemplo, el grupo "city" contiene todos los endpoints para trabajar con datos sobre ciudades.
4. Business Process. Este es el elemento de configuración más importante y es algo que no se puede ver de ninguna manera al enviar una solicitud al endpoint. La indicación del proceso de negocio determina lo que hará este endpoint. Al mismo tiempo, el propio endpoint puede permanecer sin cambios, recibirá todas las mismas peticiones en la dirección antigua, y al mismo tiempo, si el proceso de negocio es reemplazado, realizará una función completamente diferente. Los procesos de negocio para las actividades básicas de la base de datos se crean automáticamente. Se denominan procesos de negocio del sistema. Estos BPs no pueden ser modificados, pero pueden ser sustituidos en cualquier momento por BPs creados de forma independiente, con procesos de negocio personalizados.
5. Input/Output variables. El proceso de negocio creado utiliza diversas variables de entrada y salida, pero el punto final no tiene por qué utilizarlas todas. Se puede deshabilitar o configurar una parte para que diferentes puntos finales accedan al mismo BP, con un conjunto individual de variables. El tipo de solicitud y respuesta (Request / Response type) también se configura allí. Lo más habitual es que este tipo sea JSON, pero, si es necesario, se pueden utilizar otras opciones, como XML o Render File (este tipo de respuesta se utiliza en los endpoints para trabajar con archivos).

Ajustes del middleware

Los ajustes generales son suficientes para crear y seguir utilizando el endpoint, pero se pueden utilizar parámetros adicionales si es necesario. El más importante es la activación de Middleware con un token Auth.

Su uso permite denegar el acceso a este endpoint a los usuarios que no han sido autorizados o que no pertenecen a un determinado grupo (por ejemplo, se puede conceder el acceso sólo a los administradores y denegar a los demás usuarios).

Configuración de registro y salida

Además, puede utilizar la configuración de la pestaña Settings para registrar adicionalmente las cabeceras o el cuerpo de la solicitud, así como para ocultar de la respuesta aquellos campos cuyos valores no se hayan establecido.