Ajout documentation #354

klee-contrib · May 7, 2024 · 3151e95 · 3151e95
1 parent 0852ff8
commit 3151e95
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/TopModel.Generator.Javascript/javascript.config.json b/TopModel.Generator.Javascript/javascript.config.json
@@ -75,8 +75,8 @@
     },
     "apiClientFilePath": {
       "type": "string",
-      "description": "Chemin vers lequel sont créés les fichiers d'endpoints générés, relatif à la racine de l'API.",
-      "default": "{module}"
+      "description": "Chemin vers lequel sont créés les fichiers d'endpoints générés, relatif à la racine de l'API. En mode Angular, la valeur par défaut est `{module}/{filePath}.service`",
+      "default": "{module}/{filePath}"
     },
     "fetchPath": {
       "type": "string",

diff --git a/docs/generator/js.md b/docs/generator/js.md
@@ -6,7 +6,7 @@ _Remarque : tous les imports spécifiés pour le générateur JS dans les domain
 
 ### Modes de génération de l'API client
 
-Il est possible de générer l'API cliente selon deux modes (`apiMode`) : `vanilla` ou `angular`.
+Il est possible de générer l'API cliente selon deux modes (`apiMode`) : `vanilla`, `nuxt` ou `angular`.
 
 #### Angular
 
@@ -21,6 +21,13 @@ exemple :
 ```yaml
 fetchPath: "@api-services"
 ```
+### ApiFilePath
+
+Par défaut, les fichiers d'api client sont placés dans le dossier `{module}`. Ils sont nommés d'après le fichier qui les contient, sauf dans le cas du mode `angular`, où le nom du fichier sera de la forme `{fileName}.service.ts`.
+
+Pour modifier ce comportement, ajuster le paramètre `apiFilePath`.
+
+L'extension `.ts` est ajoutée automatiquement
 
 ### Modes de génération des entités