Estandar de APIs externas
Requisitos obligatorios
- Namespace con version mayor, por ejemplo
/api/external/v1. - Autenticacion de service principal con scopes minimos.
- Tenant derivado del token, nunca de headers arbitrarios.
- DTO cerrados, validacion estricta y respuestas tipadas.
Idempotency-Keyen todas las mutaciones repetibles.X-Correlation-Iden solicitudes y respuestas.- Problem Details con codigos de error estables.
- Paginacion acotada para colecciones.
- OpenAPI versionado y verificado contra breaking changes.
- Guia Docusaurus, ejemplos sinteticos y changelog en el mismo cambio.
Compatibilidad
Los cambios aditivos permanecen en la version actual. Un cambio que elimina, renombra, restringe o altera semantica observable requiere una nueva version mayor o un periodo formal de deprecacion.
Datos protegidos
La documentacion y los ejemplos nunca deben contener pacientes reales, documentos clinicos, credenciales, URLs internas, claves de idempotencia productivas ni identificadores que permitan reconstruir PII.