API de negocio con Spring Boot

SPEC

Ficha técnica

Backend: Java 17
Spring Boot
MyBatis
Datos: PostgreSQL

FIT

Encaja cuando

Las pantallas y los sistemas externos deben compartir los mismos datos de negocio
Las API existentes han crecido sin reglas comunes de permisos y errores
Hay que entregar la especificación de integración como documento

PREBUILT

Componentes de ejemplo

Estos componentes ilustran la estructura propuesta. Las funciones y el alcance se confirmarán tras la implementación y verificación.

Capa de autenticación y permisos: Inicio de sesión, verificación de tokens y control de acceso por rol ya funcionan.
Formato estándar de respuesta y error: Las respuestas de éxito y error y el esquema de códigos están definidos, con una sola regla para el cliente.
Listado, detalle y escritura: Consulta, detalle, alta, edición, borrado, paginación y orden siguen la misma convención.
Documentación de API generada: Incluye la configuración que genera la especificación desde el código, sin mantener un documento aparte.

La disposición y el diseño se adaptan a cada proyecto.

SCREENS

Pantallas de ejemplo

Pantallas de ejemplo para explorar la estructura y los flujos. El diseño y el estilo finales aún no están definidos.

Pantalla de registro con campos de metadatos como título, descripción y proveedor, más tipo de dato, URL e intervalo de ejecución. — Registro de integración · Se introducen los metadatos y el intervalo de llamada, y se comprueba la respuesta al momento.

SCOPE

Dentro del alcance

Entregables

API REST dentro del alcance acordado
Documentación de especificación de API
Código de pruebas y resultados de ejecución

Dentro del alcance

Recogida del dominio y de las reglas de negocio
Diseño e implementación de la API y gestión de permisos
Alineación del esquema de base de datos y optimización de consultas
Verificación según los criterios de aceptación y una ronda de correcciones

Fuera del alcance

Desarrollo completo del frontend
Migración completa de un sistema heredado
Monitorización continua de servidores en producción
Licencias de productos comerciales de terceros

El alcance y las exclusiones se definen antes de empezar. El calendario y las condiciones detalladas se fijan en el SOW después de hablarlo.

El problema que resuelve

Si cada pantalla trata los datos a su manera, la misma tarea produce resultados distintos. Reunir las reglas de negocio en la API hace que pantallas y sistemas externos partan de los mismos criterios.

Cómo se desarrolla

Se revisan el dominio, las reglas de negocio y el modelo de permisos.
Se fijan en el SOW la lista de API, la especificación de peticiones y respuestas y los criterios de aceptación.
Se implementan las API y se verifica el comportamiento con código de pruebas.
Se entrega junto con la documentación de especificación para su aceptación.

Alcance frente a desarrollo adicional

Una API del SOW que no cumple su especificación es un defecto. Nuevos endpoints, nuevas reglas de negocio y nuevas integraciones son desarrollo adicional y se presupuestan aparte.

FAQ

Preguntas frecuentes

¿Hay que conservar la estructura de base de datos actual?: Se utiliza primero la estructura existente. Si se necesitan cambios, se revisa el impacto y se refleja en el SOW.
¿Se puede fijar la versión de Java o del framework?: Sí, para ajustarse al entorno de producción. Las versiones fijadas se recogen en el apartado de entorno técnico del SOW.

¿Necesita una configuración concreta?

Indíqueme qué pantallas e integraciones necesita y le responderé con lo que es viable.

Consultar sobre esta configuración