diff --git a/README.md b/README.md index 9f45680..e234cf0 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,8 @@ post.requestBody.content.application/json.schema.$ref = #/components/schemas/anyValue ``` +#### Tags + 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. @@ -191,6 +193,33 @@ informations concernant les routes (qui doivent être placées dans le fichier `.ini`). +#### Exemples + +Il est très important de mettre des exemples dans la documentation OpenAPI. +Malheureusement, la syntaxe utilisée (notation pointée) pour ce faire dans les +`.ini` est très rébarbative. +Mais on peut utiliser un fichier `examples.http` placé à la racine d'une +instance et le script `bin/generate-example-metadata.mjs` pour générer ces +exemples: il exécute une requête du fichier `examples.http` et fournit les +lignes en notation pointée pour la requête et la réponse de l'exemple. + +Exemple: + +```bash +$ ./bin/generate-example-metadata.mjs mapping-tools 0 +post.requestBody.content.application/json.example.0.id: 1 +post.requestBody.content.application/json.example.0.value: 200919362L +post.requestBody.content.application/json.example.1.id: 2 +post.requestBody.content.application/json.example.1.value: 200112440X +post.responses.default.content.application/json.example.0.id: 1 +post.responses.default.content.application/json.example.0.value: INEE +post.responses.default.content.application/json.example.1.id: 2 +post.responses.default.content.application/json.example.1.value: INS2I +``` + +Il suffit ensuite de copier-coller ces lignes en haut du `.ini`, à la fin des +métadonnées. Prenez quand même garde à ne pas mettre plusieurs `example.0` (il +existe une autre syntaxe pour mettre plusieurs exemples). ### Déclarer la documentation Swagger Le répertoire `www-home` contient le HTML de la page d'accueil