Saltar al contenido principal

Publicar una API

Una API externa no esta terminada solo porque responde HTTP.

Checklist

  • OpenSpec define ownership, consumidores y escenarios.
  • El endpoint vive en un namespace externo versionado.
  • El request y response usan DTO cerrados.
  • La operacion declara scopes y deriva el tenant del token.
  • Las mutaciones implementan idempotencia y concurrencia.
  • Los errores usan codigos estables y Problem Details.
  • OpenAPI incluye ejemplos, headers y respuestas de error.
  • OpenAPI incluye ejemplos cURL y JavaScript mediante x-codeSamples.
  • Las pruebas cubren tenant, permisos, replay y conflictos.
  • Docusaurus explica el caso de uso y contiene ejemplos sinteticos.
  • La coleccion y el ambiente Postman se regeneraron y verificaron por checksum.
  • El changelog indica fecha, version y compatibilidad.

Fuente de verdad

El OpenAPI debe vivir junto al API Gateway propietario. Docusaurus puede generar o presentar la referencia, pero no debe mantener una copia manual divergente del contrato.