API-first
API-first es un enfoque que define las interfaces y contratos de una solución como parte central de su diseño
Qué significa, cómo se usa y en qué contexto aparece, con sus conceptos relacionados.
Qué es y cómo funciona
Facilita coordinar equipos y consumidores antes de completar la implementación. Requiere acordar datos, errores, permisos y evolución. Diseñar una API primero no elimina la necesidad de investigar las tareas y necesidades que debe atender.
Temas
Preguntas frecuentes sobre API-first
¿Qué debe contener un contrato de API antes de programarla?
Debe describir operaciones, datos, validaciones y respuestas, incluidos los errores que el consumidor necesita interpretar. También necesita explicar autenticación, compatibilidad y cómo se introducirán cambios. Un ejemplo exitoso no cubre todo el contrato. Probarlo con quienes lo van a utilizar permite detectar ambigüedades antes de implementarlo, como campos opcionales que alguien interpreta como obligatorios o estados que no permiten saber si una operación puede repetirse.