Cada organización debe definir una API Template, un documento OpenAPI que ayuda a los desarrolladores a agilizar la definición. Pero, ¿cómo? Te lo contamos en este post.
API Governance
¿Qué es el API Template?
Es un documento OpenAPI que describe un ejemplo de cómo hay que implementar el estándar de definición y que ayuda a los desarrolladores a agilizar la definición de los mismos.
¿Qué debería incorporar dicho documento?
Conceptos clave para mi API Template
Seguridad
Debe incorporar la seguridad del gobierno de APIs.
Ejemplos de CRUD
Ejemplos de un GET, PUT, PATCH, DELETE y POST.
Códigos de error
Debe incorporar todos los códigos de error de todas las piezas que trabajan en las APIs.
Repo de definición
Debe estar en un repo independiente que genere el repo de definición.
// ¿Necesitas ayuda con tu gobierno de APIs?
¡Habla con nosotros y te ayudaremos!
