OpenAPI | Bibliothèque

L'analyseur OpenAPI peut être utilisé comme bibliothèque partagée (DLL) afin que vous puissiez générer des clients Pascal depuis vos propres applications sans invoquer l'outil en ligne de commande. La bibliothèque exporte un petit ensemble de fonctions qui encapsulent les mêmes fonctionnalités d'analyseur disponibles dans le CLI.

 

Fonctions de bibliothèque

• CreateOpenAPIPascalFile - crée un fichier client Pascal à partir d'une spécification OpenAPI en utilisant les options par défaut.
• CreateOpenAPIPascalFileEx - crée un fichier client Pascal avec contrôle total sur les options de l'analyseur.
• GetOpenAPILastErrors - retourne le dernier message d'erreur produit par l'analyseur.

 

CreateOpenAPIPascalFile

Génère un fichier client Pascal en utilisant les options d'analyse par défaut (générer des classes, support JSON, documentation, noms de méthodes à partir de OperationId, sans authentification, sans remplacement d'URL de base).

 

function CreateOpenAPIPascalFile(const aInputFile, aOutputFile: PWideChar): Boolean; stdcall;

 

 

Paramètres

• aInputFile : chemin complet (ou URL) de la spécification OpenAPI à analyser. Si le fichier est YAML ou Swagger 1/2, le parseur le normalisera en JSON OpenAPI 3 avant de générer la sortie.
• aOutputFile : chemin complet de l'unité Pascal à créer.
•  

Valeur de retour

Retourne True si le fichier est généré avec succès, sinon False. En cas d'échec, appelez GetOpenAPILastErrors pour récupérer le message d'erreur.

 

Exemple

if not CreateOpenAPIPascalFile('c:\specs\openapi.json', 'c:\clients\orders.pas') then
  ShowMessage(GetOpenAPILastErrors);

 

CreateOpenAPIPascalFileEx

Génère un fichier client Pascal avec un contrôle explicite sur les options du parseur.

 

function CreateOpenAPIPascalFileEx(const aInputFile, aOutputFile: PWideChar;
  aGenerateClasses, aGenerateJSON, aGenerateDocumentation: Boolean;
  aMethodsName, aAuthentication: Integer; const aBaseURL: PWideChar;
  aEnableLog: Boolean): Boolean; stdcall;

 

 

Paramètres

• aInputFile: chemin complet (ou URL) de la spécification OpenAPI à analyser.
• aOutputFile : chemin complet de l'unité Pascal à créer.
• aGenerateClasses : lorsque True, le générateur crée les modèles Pascal (classes) définis dans le schéma. Lorsque False, seule l'interface client est générée.
• aGenerateJSON : lorsque True, des helpers de sérialisation JSON sont générés dans les classes. Lorsque False, la prise en charge JSON est omise.
• aGenerateDocumentation : lorsque True, un fichier de documentation pour la spécification OpenAPI est généré.
• aMethodsName : contrôle la façon dont les noms de méthodes sont générés :
  • 0 = OperationId (par défaut).
  • 1 = Summary.
  • 2 = Endpoint.
• aAuthentication : ajoute des assistants d'authentification au client :
  • 0 = Aucun.
  • 1 = Basic.
  • 2 = Jeton.
  • 3 = OAuth2.
  • 4 = JWT.
• aBaseURL : remplace l'URL de base de la spécification OpenAPI. Passez une chaîne vide pour conserver la valeur d'origine.
• aEnableLog : lorsque True, l'analyseur écrit des messages de progression et de validation qui peuvent aider au dépannage.

 

Valeur de retour

Retourne True si le fichier est généré avec succès, sinon False. En cas d'échec, appelez GetOpenAPILastErrors pour récupérer le message d'erreur.

 

Exemple

if not CreateOpenAPIPascalFileEx(
  'c:\specs\openapi.json',
  'c:\clients\orders.pas',
  True, True, True,
  0, 3,
  'https://api.example.com/v2',
  True) then
  ShowMessage(GetOpenAPILastErrors);

 

GetOpenAPILastErrors

Retourne un message décrivant la dernière erreur (de validation, de conversion ou d'analyse) produite par le parseur. Appelez cette fonction après que CreateOpenAPIPascalFile ou CreateOpenAPIPascalFileEx retourne False.

 

 

function GetOpenAPILastErrors(var Errors: PWideChar): Integer; stdcall;

 

 

Valeur de retour

Retourne le nombre d'erreurs

 

Exemple

if not CreateOpenAPIPascalFile('c:\specs\openapi.yaml', 'c:\clients\orders.pas') then
  GetOpenAPILastErrors(vErrors);