Cos'è OpenAPI 3.x?

OpenAPI è la specifica standard del settore per descrivere le API RESTful. Precedentemente nota come Swagger, abilita la generazione automatica di codice, documentazione e test.

Lo standard delle API

OpenAPI fornisce un formato leggibile dalle macchine per descrivere le API HTTP, consentendo agli strumenti di generare automaticamente codice, documentazione e suite di test.

Le origini di Swagger

Swagger 1.x e 2.x hanno gettato le basi per i formati di descrizione delle API. La specifica è stata donata alla OpenAPI Initiative nel 2015 ed è evoluta in OpenAPI 3.x.

OpenAPI 3.x

Lo standard attuale supporta i formati JSON e YAML, definizioni di schema avanzate, più schemi di autenticazione, webhook e collegamenti tra operazioni.

Integrazione con Delphi

sgcOpenAPI analizza qualsiasi specifica OpenAPI o Swagger e genera codice Object Pascal nativo — offrendo agli sviluppatori Delphi strumenti API di prim'ordine.

Cosa descrive una specifica

Endpoint e operazioni

Percorsi, metodi HTTP (GET, POST, PUT, DELETE), parametri di query, header e corpi delle richieste sono tutti definiti in un formato strutturato.

Schemi e modelli

Tipi di dati, proprietà degli oggetti, array, enumerazioni e composizione (allOf, oneOf, anyOf) descrivono la struttura dei payload di richiesta e risposta.

Autenticazione

Chiavi API, flussi OAuth 2.0, token HTTP Bearer e OpenID Connect sono definiti come schemi di sicurezza riutilizzabili applicati alle operazioni.

Porta OpenAPI in Delphi

Genera SDK Pascal nativi a partire da qualsiasi specifica OpenAPI.