diff --git a/README.md b/README.md index fb6e520..17a6b32 100644 --- a/README.md +++ b/README.md @@ -157,13 +157,37 @@ }] ``` -## Déclarer la documentation Swagger +## Documenter + +### Documentation OpenAPI + +Chaque service, chaque route doit être documenté en respectant la norme OpenAPI 3.0 (swagger). + +La documentation de chaque route doit être placée dans le fichier .ini correspondant à sa route API. + +Pour placer la document openapi dans les fichiers .ini, la syntaxe Swagger au format JSON doit être convertie au format "dot notation" + +Exemple : + +```ini +post.responses.default.description = Return a JSON as received JSON. +post.responses.default.content.application/json.schema.$ref = #/components/schemas/anyValue +post.summary = Parse and split JSON and return it. +post.requestBody.required = true +post.requestBody.content.application/json.schema.$ref = #/components/schemas/anyValue +``` + +Si vous souhaitez enrichir la documentation par défaut, en ajoutant des "tags", des components, il est possible d'ajouter un fichier standard `swagger.json` à la racine de votre instance. +Le serveur prendra en compte tout le fichier SAUF ce qui correspond aux informations concernant les routes +(qui doivent être placées dans le fichiers .ini) + + +### Déclarer la documentation Swagger Le répertoire `www-home` contient le HTML de la page d'accueil . -Si la racine de votre service répond une documentation respectant OpenAPI 3.0 -(swagger), il vous suffit de la déclarer dans `www-home/index.html` pour qu'elle +Pour ajouter une instance dans le menu déroulant (en haut à droite), il vous suffit de la déclarer dans `www-home/index.html` pour qu'elle soit prise en compte. ## Convention de nommage