Saltar a contenido

Especificación OpenAPI

El contrato de /v1 se genera desde el propio código — no es una descripción escrita a mano que pueda desincronizarse del comportamiento real. Puedes obtener el documento OpenAPI 3.1 completo (rutas, parámetros, esquemas de petición y de respuesta) en cualquier momento con:

GET https://api.hodeishield.com/v1/openapi.json

Esa ruta no requiere autenticación y siempre refleja la versión desplegada.

Cómo usarlo

  • Swagger UI / Redoc: apunta la herramienta a la URL anterior para navegar la especificación de forma interactiva.
  • Generadores de cliente (openapi-generator, orval, …): genera un cliente tipado en tu lenguaje directamente desde el documento.
  • Postman / Insomnia: importa la URL como colección para probar las operaciones sin escribir código.

Qué NO es este documento

La tabla de operaciones de esta guía resume el contrato para lectura humana; el documento generado en /v1/openapi.json es la fuente autoritativa y prevalece sobre cualquier resumen si hay discrepancia.