API Template

API Governance

¿Qué es el API Template?


Cada organización debe definir una API Template, que 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.

Pero, ¿Qué debería incorporar dicho documento?

Odoo text and image block

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.

Leave a comment

You must be logged in to post a comment.