OpenAPI Specification
Especificación OpenAPI
La Especificación OpenAPI es una forma neutral al lenguaje de describir una API HTTP. Enumera acciones, entradas, estructuras de datos, métodos de seguridad, respuestas y esquemas reutilizables.
Otro ejemplo
Una API asociada describe `POST /claims` y su cabecera de idempotencia requerida. También lista el alcance de OAuth, reglas de JSON Schema, respuestas 201 y de problemas, y ejemplos con datos falsos. CI bloquea una respuesta que rompe cambios y que no fue documentada. Los clientes generados todavía se revisan en lugar de confiarse sin verificaciones.
Partes principales
- 01Metadatos y servidores de la API
- 02Rutas y operaciones
- 03Esquemas, seguridad y respuestas
Úsalo cuando
Úsalo como un contrato que la gente pueda revisar para documentación, verificaciones, servidores simulados, generación de clientes y pruebas de compatibilidad.
No lo uses cuando
Los documentos generados no reemplazan ejemplos reales, pruebas de autorización, verificaciones en tiempo de ejecución o un comportamiento claro en producción.
Nombre usado en código
openapi document: paths, operations, components/schemas, securitySchemes, responses Antes de lanzarlo
Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback.
Outcome: Complete the task with Especificación OpenAPI (OpenAPI Specification). User context: Una API asociada describe `POST /claims` y su cabecera de idempotencia requerida. También lista el alcance de OAuth, reglas de JSON Schema, respuestas 201 y de problemas, y ejemplos con datos falsos. CI bloquea una respuesta que rompe cambios y que no fue documentada. Los clientes generados todavía se revisan en lugar de confiarse sin verificaciones. Technical concept or control: Especificación OpenAPI (OpenAPI Specification). Why it fits: Úsalo como un contrato que la gente pueda revisar para documentación, verificaciones, servidores simulados, generación de clientes y pruebas de compatibilidad. Do not use it when: Los documentos generados no reemplazan ejemplos reales, pruebas de autorización, verificaciones en tiempo de ejecución o un comportamiento claro en producción. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary): Un documento formal aún puede ser un borrador, un release candidate o una versión final. Revisa su estado y la compatibilidad con tu navegador o plataforma. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.
Revisa esta petición
Review how Especificación OpenAPI (OpenAPI Specification) is used now. Definition: La Especificación OpenAPI es una forma neutral al lenguaje de describir una API HTTP. Enumera acciones, entradas, estructuras de datos, métodos de seguridad, respuestas y esquemas reutilizables. Release checks: Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.