Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
prog:theorie:api:swagger [20/10/2019 18:12]
thierry [Installation]
prog:theorie:api:swagger [18/10/2022 11:29] (Version actuelle)
thierry ↷ Page déplacée de prog:api:swagger à prog:theorie:api:swagger
Ligne 58: Ligne 58:
 ===== Configurer le projet ===== ===== Configurer le projet =====
 dans votre projet creer un dossier ''​swagger''​ dans votre projet creer un dossier ''​swagger''​
 +==== Le fichier source swagger.php ====
 +
  
 Dans ce dossier créer un fichier ''​swagger.php''​ qui contiendra les infos de bases de vos APIs sous forme d'​Annotations Dans ce dossier créer un fichier ''​swagger.php''​ qui contiendra les infos de bases de vos APIs sous forme d'​Annotations
Ligne 74: Ligne 76:
  */  */
 </​code>​ </​code>​
 +
 +==== Compilation du fichier en json ====
 +
  
 Executer la commande ''​vendor\bin\openapi.bat --format json --output public\swagger\swagger.json swagger\swagger.php src ''​ pour generer un fichier JSON (swagger.json) de description des vos API dans le dossier ''​public''​ Executer la commande ''​vendor\bin\openapi.bat --format json --output public\swagger\swagger.json swagger\swagger.php src ''​ pour generer un fichier JSON (swagger.json) de description des vos API dans le dossier ''​public''​
 +
 +
 <​code>​ <​code>​
 D:​\webprojects\test-api-project>​vendor\bin\openapi.bat --format json --output public\swagger\swagger.json swagger\swagger.php src  D:​\webprojects\test-api-project>​vendor\bin\openapi.bat --format json --output public\swagger\swagger.json swagger\swagger.php src 
Ligne 81: Ligne 88:
 </​code>​ </​code>​
  
 +==== Resultats swagger.json ====
 Le fichier généré est celui là : Le fichier généré est celui là :
 <code json swagger.json>​ <code json swagger.json>​