Wat is OpenAPI 3.x?

OpenAPI is de industriestandaard-specificatie voor het beschrijven van RESTful API's. Voorheen bekend als Swagger, maakt het geautomatiseerde codegeneratie, documentatie en testing mogelijk.

De API-standaard

OpenAPI biedt een machineleesbaar formaat voor het beschrijven van HTTP-API's, zodat tools automatisch code, documentatie en testsuites kunnen genereren.

Swagger-oorsprong

Swagger 1.x en 2.x legden de basis voor API-beschrijvingsformaten. De specificatie werd in 2015 geschonken aan het OpenAPI Initiative en evolueerde naar OpenAPI 3.x.

OpenAPI 3.x

De huidige standaard ondersteunt JSON- en YAML-formaten, geavanceerde schemadefinities, meerdere authenticatieschema's, webhooks en koppelingen tussen operations.

Delphi-integratie

sgcOpenAPI parseert elke OpenAPI- of Swagger-specificatie en genereert native Object Pascal-code — en geeft Delphi-ontwikkelaars eersteklas API-tooling.

Wat een specificatie beschrijft

Endpoints & operations

Paths, HTTP-methodes (GET, POST, PUT, DELETE), queryparameters, headers en request bodies worden allemaal in een gestructureerd formaat gedefinieerd.

Schema's & modellen

Datatypes, objecteigenschappen, arrays, enumeraties en compositie (allOf, oneOf, anyOf) beschrijven de vorm van request- en response-payloads.

Authenticatie

API-sleutels, OAuth 2.0-flows, HTTP Bearer-tokens en OpenID Connect worden gedefinieerd als herbruikbare security-schemes die op operations worden toegepast.

Breng OpenAPI naar Delphi

Genereer native Pascal-SDK's vanuit elke OpenAPI-specificatie.