OpenAPI | Ligne de commande

Le parseur sgcOpenAPI inclut une interface en ligne de commande qui convertit une spécification OpenAPI en un fichier client Delphi (Pascal). Le parseur valide et normalise la spécification (OpenAPI 3 JSON + schémas groupés) avant de générer la sortie.

 

Utilisation

Syntaxe de base

 

sgcOpenAPI.exe -i "c:\openapi.json" -o "c:\openapi.pas"

 

Paramètres

Tous les paramètres sont insensibles à la casse. Les formes courtes et longues sont équivalentes.

 

• -i -input : [obligatoire] Chemin vers la spécification OpenAPI ou une URL à télécharger. Si l'entrée est YAML ou Swagger 1/2, elle sera automatiquement convertie en JSON OpenAPI 3.
• -o -output : [obligatoire] Fichier Pascal de sortie à générer (client Delphi).
• -nc -nclasses : [optionnel] Ne pas générer de classes Delphi pour les schémas (interfaces/méthodes client uniquement).
• -nj -njson : [optionnel] Ne pas activer la sérialisation JSON pour les classes générées.
• -nd -ndoc : [optionnel] Ne pas générer de commentaires de documentation dans la sortie.
• -m -method : [optionnel] Stratégie de nommage des méthodes pour les méthodes générées :
  • 0 : Utiliser OperationId (par défaut).
  • 1 : Utiliser Summary.
  • 2 : Utiliser le chemin Endpoint.
• -a -auth : [optionnel] Mode d'authentification à activer dans le client généré :
  • 0 : Aucun.
  • 1 : Basic.
  • 2 : Jeton.
  • 3 : OAuth2.
  • 4 : JWT.
• -u -url : [optionnel] Remplace l'URL de base détectée dans le fichier OpenAPI.
• -l -log : [optionnel] Afficher la sortie du journal lors de l'analyse.
• -user : [optionnel] Nom d'utilisateur de la licence (requis uniquement si la licence n'a pas été activée).
• -password : [facultatif] Mot de passe de licence (requis uniquement lorsque la licence n'a pas été activée).
• -h -help : Afficher l'aide en ligne de commande.

 

Exemples

1) Générer un client Delphi à partir d'un fichier local

 

sgcOpenAPI.exe -i "c:\specs\openapi.json" -o "c:\clients\orders.pas"

 

2) Générer le client depuis une URL, désactiver les classes et la documentation

 

sgcOpenAPI.exe -i "https://api.example.com/openapi.json" -o "c:\clients\api.pas" -nc -nd

 

3) Utiliser Summary comme noms de méthodes et activer OAuth2

 

sgcOpenAPI.exe -i "c:\specs\openapi.json" -o "c:\clients\auth.pas" -m 1 -a 3

 

4) Remplacer l'URL de base et afficher la sortie du journal

 

sgcOpenAPI.exe -i "c:\specs\openapi.json" -o "c:\clients\override.pas" -u "https://api.example.com/v2" -l

 

Remarques

• Si la spécification d'entrée n'est pas valide ou n'est pas un fichier JSON OpenAPI 3 groupé, le parseur tentera de la convertir et de la grouper automatiquement avant la génération.
• Lors de l'utilisation d'URLs, l'analyseur télécharge la spécification avant de valider et de générer la sortie.