Skip to content

Commit aa5a814

Browse files
Updated templates readme
1 parent 230a33b commit aa5a814

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

templates/Readme.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,28 @@ transform-swagger -f URI/TO/SWAGGER/JSON/OR/YAML -o src/generatedApi/ -t ./path/
4040
### 4 - Just enjoy your saved time!
4141

4242
Easy, right?
43+
44+
45+
## File naming (for each template)
46+
47+
Some files are customizable in a `config.js`, that files are explained in `TemplateConfigI` (and are self-explanatory).
48+
### config.js
49+
50+
File which specify mappings.
51+
This file implement `TemplateConfigI` interface (`src/models/template-config.model.ts`).
52+
53+
### api.?
54+
55+
File used as template to generate each `Api` class.
56+
57+
An API class is composed by some `endpoints` which share the `same 1rst "tag"`.
58+
59+
### model.?
60+
61+
File used to generate `each model`.
62+
63+
It's exported in a shared folder with all models.
64+
65+
### enumModel.?
66+
67+
Same as `model` but for `enums`.

0 commit comments

Comments
 (0)