Volver al glosario
API / Developer

OpenAPI

También conocido como: Swagger, OAS

Definición

OpenAPI (antes Swagger) es el estándar abierto para describir APIs REST en formato YAML/JSON. Permite generar documentación interactiva, SDKs y mock servers automáticamente.

Contexto LATAM

Una OpenAPI spec describe cada endpoint, parámetros, schemas de request/response, autenticación y ejemplos. Es el lenguaje compartido entre devs frontend, backend y herramientas de testing.

Ejemplo concreto

La spec OpenAPI de finO$ está publicada, así que puedes generar un cliente en Go sin esperar a un SDK oficial: `openapi-generator-cli generate -i https://api.getfinos.com/api/v1/openapi.json -g go -o ./finos-go-sdk`.

Cómo aparece en tu estado de cuenta

Es la descripción formal de una API, no algo presente en un estado de cuenta. Su utilidad práctica es que a partir de ese archivo se generan clientes, se validan respuestas y se documenta sin escribir la documentación dos veces.

¿Cómo lo maneja finO$?

La spec vive en api.getfinos.com/api/v1/openapi.json y es la fuente de la referencia del API en este sitio.

Términos relacionados

¿Necesitas convertir estados de cuenta bancarios a datos estructurados?

¿Solo un archivo? Usa el convertidor para convertir estado de cuenta a Excel gratis.

Preguntas frecuentes sobre OpenAPI

¿Para qué me sirve el archivo OpenAPI si ya hay documentación?

Porque es ejecutable: podés generar un cliente en tu lenguaje, cargarlo en herramientas como Postman o validar automáticamente que las respuestas cumplen el contrato. La documentación explica; la especificación se verifica.

¿Si un campo no está en el OpenAPI, existe?

Tratalo como que no. La especificación es el contrato, y construir sobre campos no documentados es apoyarse en algo que puede cambiar sin aviso ni versión nueva.