¿Qué es OpenAPI 3.x?

OpenAPI es la especificación estándar del sector para describir APIs RESTful. Antes conocida como Swagger, permite generar código, documentación y pruebas de forma automatizada.

El estándar de APIs

OpenAPI proporciona un formato legible por máquina para describir APIs HTTP, lo que permite a las herramientas generar código, documentación y conjuntos de pruebas automáticamente.

Orígenes de Swagger

Swagger 1.x y 2.x sentaron las bases de los formatos de descripción de APIs. La especificación se donó a la OpenAPI Initiative en 2015 y evolucionó hasta convertirse en OpenAPI 3.x.

OpenAPI 3.x

El estándar actual admite formatos JSON y YAML, definiciones de esquema avanzadas, múltiples esquemas de autenticación, webhooks y enlaces entre operaciones.

Integración con Delphi

sgcOpenAPI parsea cualquier especificación de OpenAPI o Swagger y genera código Object Pascal nativo, dando a los desarrolladores Delphi herramientas de API de primera clase.

Qué describe una especificación

Endpoints y operaciones

Paths, métodos HTTP (GET, POST, PUT, DELETE), parámetros de consulta, cabeceras y cuerpos de solicitud, todo se define en un formato estructurado.

Esquemas y modelos

Los tipos de datos, propiedades de objeto, arrays, enumeraciones y composición (allOf, oneOf, anyOf) describen la forma de los payloads de solicitud y respuesta.

Autenticación

Claves de API, flujos OAuth 2.0, tokens HTTP Bearer y OpenID Connect se definen como esquemas de seguridad reutilizables aplicados a las operaciones.

Lleva OpenAPI a Delphi

Genera SDK nativos de Pascal a partir de cualquier especificación de OpenAPI.