Qu'est-ce qu'OpenAPI 3.x ?

OpenAPI est la spécification standard du secteur pour décrire les API RESTful. Anciennement connue sous le nom de Swagger, elle permet la génération automatique de code, de documentation et de tests.

Le standard d'API

OpenAPI fournit un format lisible par machine pour décrire les API HTTP, permettant aux outils de générer automatiquement du code, de la documentation et des suites de tests.

Origines Swagger

Swagger 1.x et 2.x ont posé les bases des formats de description d'API. La spécification a été donnée à l'OpenAPI Initiative en 2015 et a évolué en OpenAPI 3.x.

OpenAPI 3.x

Le standard actuel prend en charge les formats JSON et YAML, des définitions de schéma avancées, plusieurs schémas d'authentification, les webhooks et les liens entre opérations.

Intégration Delphi

sgcOpenAPI analyse n'importe quelle spécification OpenAPI ou Swagger et génère du code Object Pascal natif — offrant aux développeurs Delphi un outillage d'API de premier ordre.

Ce que décrit une spécification

Endpoints & opérations

Les chemins, méthodes HTTP (GET, POST, PUT, DELETE), paramètres de requête, en-têtes et corps de requêtes sont tous définis dans un format structuré.

Schémas & modèles

Les types de données, propriétés d'objets, tableaux, énumérations et compositions (allOf, oneOf, anyOf) décrivent la forme des charges utiles de requêtes et réponses.

Authentification

Les clés API, flux OAuth 2.0, jetons HTTP Bearer et OpenID Connect sont définis comme des schémas de sécurité réutilisables appliqués aux opérations.

Apporte OpenAPI à Delphi

Génère des SDK Pascal natifs depuis n'importe quelle spécification OpenAPI.