Skip to content

Commit 364d6b0

Browse files
aryobenholzneraryobenholzner
committed
added docs
1 parent dc89dcc commit 364d6b0

File tree

2 files changed

+277
-0
lines changed

2 files changed

+277
-0
lines changed

‎docs/generators.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ The following generators are available:
150150
* [scala-play-server](generators/scala-play-server.md)
151151
* [scalatra](generators/scalatra.md)
152152
* [spring](generators/spring.md)
153+
* [typescript-nestjs-server (beta)](generators/typescript-nestjs-server.md)
153154

154155

155156
## DOCUMENTATION generators

‎docs/generators/typescript-nestjs-server.md

Lines changed: 276 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,276 @@
1+
---
2+
title: Documentation for the typescript-nestjs-server Generator
3+
---
4+
5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
|-------------------------------------|----------------------------------------------|--------------------------------------------|
9+
| generator name | typescript-nestjs-server | pass this to the generate command after -g |
10+
| generator stability | BETA | |
11+
| generator type | SERVER | |
12+
| generator language | Typescript | |
13+
| generator default templating engine | mustache | |
14+
| helpTxt | Generates a TypeScript NestJS server module. | |
15+
16+
## CONFIG OPTIONS
17+
18+
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer
19+
to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
20+
21+
| Option | Description | Values | Default |
22+
|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------|
23+
| allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | | false |
24+
| fileNaming | Naming convention for the output files: 'camelCase', 'kebab-case'. | | kebab-case |
25+
| modelFileSuffix | The suffix of the file of the generated model (model<suffix>.ts). | | null |
26+
| modelSuffix | The suffix of the generated model. | | null |
27+
| nestVersion | The version of Nestjs. (At least 10.0.0) | | 10.0.0 |
28+
| npmName | The name under which you want to publish generated npm package. Required to generate a full package | | null |
29+
| npmRepository | Use this property to set an url your private npmRepo in the package.json | | null |
30+
| npmVersion | The version of your npm package. If not provided, using the version from the OpenAPI specification file. | | 1.0.0 |
31+
| nullSafeAdditionalProps | Set to make additional properties types declare that their indexer may return undefined | | false |
32+
| paramNaming | Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name | | camelCase |
33+
| rxjsVersion | The version of RxJS compatible with NestJS (see ngVersion option). | | null |
34+
| apiFileSuffix | The suffix of the file of the generated API class (api<suffix>.ts). | | .api |
35+
| apiSuffix | The suffix of the generated API class | | Api |
36+
| stringEnums | Generate string enums instead of objects for enum values. | | false |
37+
| taggedUnions | Use discriminators to create tagged unions instead of extending interfaces. | | false |
38+
| tsVersion | The version of typescript compatible with Angular (see ngVersion option). | | null |
39+
| useSingleRequestParameter | Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter. | | false |
40+
41+
## IMPORT MAPPING
42+
43+
| Type/Alias | Imports |
44+
|------------|---------|
45+
46+
## INSTANTIATION TYPES
47+
48+
| Type/Alias | Instantiated By |
49+
|----------------------|-----------------|
50+
| array | Array |
51+
| additionalProperties | Record |
52+
53+
## LANGUAGE PRIMITIVES
54+
55+
<ul class="column-ul">
56+
<li>Array</li>
57+
<li>Blob</li>
58+
<li>Boolean</li>
59+
<li>Date</li>
60+
<li>Double</li>
61+
<li>Error</li>
62+
<li>File</li>
63+
<li>Float</li>
64+
<li>Integer</li>
65+
<li>Long</li>
66+
<li>Map</li>
67+
<li>Object</li>
68+
<li>ReadonlyArray</li>
69+
<li>Record</li>
70+
<li>Set</li>
71+
<li>String</li>
72+
<li>any</li>
73+
<li>boolean</li>
74+
<li>number</li>
75+
<li>object</li>
76+
<li>string</li>
77+
</ul>
78+
79+
## RESERVED WORDS
80+
81+
<ul class="column-ul">
82+
<li>abstract</li>
83+
<li>await</li>
84+
<li>boolean</li>
85+
<li>break</li>
86+
<li>byte</li>
87+
<li>case</li>
88+
<li>catch</li>
89+
<li>char</li>
90+
<li>class</li>
91+
<li>const</li>
92+
<li>continue</li>
93+
<li>debugger</li>
94+
<li>default</li>
95+
<li>delete</li>
96+
<li>do</li>
97+
<li>double</li>
98+
<li>else</li>
99+
<li>enum</li>
100+
<li>export</li>
101+
<li>extends</li>
102+
<li>false</li>
103+
<li>final</li>
104+
<li>finally</li>
105+
<li>float</li>
106+
<li>for</li>
107+
<li>formParams</li>
108+
<li>function</li>
109+
<li>goto</li>
110+
<li>headerParams</li>
111+
<li>if</li>
112+
<li>implements</li>
113+
<li>import</li>
114+
<li>in</li>
115+
<li>instanceof</li>
116+
<li>int</li>
117+
<li>interface</li>
118+
<li>let</li>
119+
<li>long</li>
120+
<li>native</li>
121+
<li>new</li>
122+
<li>null</li>
123+
<li>package</li>
124+
<li>private</li>
125+
<li>protected</li>
126+
<li>public</li>
127+
<li>queryParameters</li>
128+
<li>requestOptions</li>
129+
<li>return</li>
130+
<li>short</li>
131+
<li>static</li>
132+
<li>super</li>
133+
<li>switch</li>
134+
<li>synchronized</li>
135+
<li>this</li>
136+
<li>throw</li>
137+
<li>transient</li>
138+
<li>true</li>
139+
<li>try</li>
140+
<li>typeof</li>
141+
<li>useFormData</li>
142+
<li>var</li>
143+
<li>varLocalDeferred</li>
144+
<li>varLocalPath</li>
145+
<li>void</li>
146+
<li>volatile</li>
147+
<li>while</li>
148+
<li>with</li>
149+
<li>yield</li>
150+
</ul>
151+
152+
## FEATURE SET
153+
154+
### Client Modification Feature
155+
156+
| Name | Supported | Defined By |
157+
|----------------|-----------|------------------|
158+
| BasePath | ✓ | ToolingExtension
159+
| Authorizations | ✗ | ToolingExtension
160+
| UserAgent | ✗ | ToolingExtension
161+
| MockServer | ✗ | ToolingExtension
162+
163+
### Data Type Feature
164+
165+
| Name | Supported | Defined By |
166+
|-------------------------------|-----------|------------------|
167+
| Custom | ✗ | OAS2,OAS3
168+
| Int32 | ✓ | OAS2,OAS3
169+
| Int64 | ✓ | OAS2,OAS3
170+
| Float | ✓ | OAS2,OAS3
171+
| Double | ✓ | OAS2,OAS3
172+
| Decimal | ✓ | ToolingExtension
173+
| String | ✓ | OAS2,OAS3
174+
| Byte | ✓ | OAS2,OAS3
175+
| Binary | ✓ | OAS2,OAS3
176+
| Boolean | ✓ | OAS2,OAS3
177+
| Date | ✓ | OAS2,OAS3
178+
| DateTime | ✓ | OAS2,OAS3
179+
| Password | ✓ | OAS2,OAS3
180+
| File | ✓ | OAS2
181+
| Uuid | ✗ |
182+
| Array | ✓ | OAS2,OAS3
183+
| Null | ✗ | OAS3
184+
| AnyType | ✗ | OAS2,OAS3
185+
| Object | ✓ | OAS2,OAS3
186+
| Maps | ✓ | ToolingExtension
187+
| CollectionFormat | ✓ | OAS2
188+
| CollectionFormatMulti | ✓ | OAS2
189+
| Enum | ✓ | OAS2,OAS3
190+
| ArrayOfEnum | ✓ | ToolingExtension
191+
| ArrayOfModel | ✓ | ToolingExtension
192+
| ArrayOfCollectionOfPrimitives | ✓ | ToolingExtension
193+
| ArrayOfCollectionOfModel | ✓ | ToolingExtension
194+
| ArrayOfCollectionOfEnum | ✓ | ToolingExtension
195+
| MapOfEnum | ✓ | ToolingExtension
196+
| MapOfModel | ✓ | ToolingExtension
197+
| MapOfCollectionOfPrimitives | ✓ | ToolingExtension
198+
| MapOfCollectionOfModel | ✓ | ToolingExtension
199+
| MapOfCollectionOfEnum | ✓ | ToolingExtension
200+
201+
### Documentation Feature
202+
203+
| Name | Supported | Defined By |
204+
|--------|-----------|------------------|
205+
| Readme | ✓ | ToolingExtension
206+
| Model | ✓ | ToolingExtension
207+
| Api | ✓ | ToolingExtension
208+
209+
### Global Feature
210+
211+
| Name | Supported | Defined By |
212+
|-------------------------|-----------|------------|
213+
| Host | ✓ | OAS2,OAS3
214+
| BasePath | ✓ | OAS2,OAS3
215+
| Info | ✓ | OAS2,OAS3
216+
| Schemes | ✗ | OAS2,OAS3
217+
| PartialSchemes | ✓ | OAS2,OAS3
218+
| Consumes | ✓ | OAS2
219+
| Produces | ✓ | OAS2
220+
| ExternalDocumentation | ✓ | OAS2,OAS3
221+
| Examples | ✓ | OAS2,OAS3
222+
| XMLStructureDefinitions | ✗ | OAS2,OAS3
223+
| MultiServer | ✗ | OAS3
224+
| ParameterizedServer | ✗ | OAS3
225+
| ParameterStyling | ✓ | OAS3
226+
| Callbacks | ✗ | OAS3
227+
| LinkObjects | ✗ | OAS3
228+
229+
### Parameter Feature
230+
231+
| Name | Supported | Defined By |
232+
|---------------|-----------|------------|
233+
| Path | ✓ | OAS2,OAS3
234+
| Query | ✓ | OAS2,OAS3
235+
| Header | ✓ | OAS2,OAS3
236+
| Body | ✓ | OAS2
237+
| FormUnencoded | ✓ | OAS2
238+
| FormMultipart | ✓ | OAS2
239+
| Cookie | ✓ | OAS3
240+
241+
### Schema Support Feature
242+
243+
| Name | Supported | Defined By |
244+
|--------------|-----------|------------|
245+
| Simple | ✓ | OAS2,OAS3
246+
| Composite | ✓ | OAS2,OAS3
247+
| Polymorphism | ✓ | OAS2,OAS3
248+
| Union | ✗ | OAS3
249+
| allOf | ✗ | OAS2,OAS3
250+
| anyOf | ✗ | OAS3
251+
| oneOf | ✗ | OAS3
252+
| not | ✗ | OAS3
253+
254+
### Security Feature
255+
256+
| Name | Supported | Defined By |
257+
|--------------------------|-----------|------------------|
258+
| BasicAuth | ✓ | OAS2,OAS3
259+
| ApiKey | ✓ | OAS2,OAS3
260+
| OpenIDConnect | ✗ | OAS3
261+
| BearerToken | ✓ | OAS3
262+
| OAuth2_Implicit | ✓ | OAS2,OAS3
263+
| OAuth2_Password | ✗ | OAS2,OAS3
264+
| OAuth2_ClientCredentials | ✗ | OAS2,OAS3
265+
| OAuth2_AuthorizationCode | ✗ | OAS2,OAS3
266+
| SignatureAuth | ✗ | OAS3
267+
| AWSV4Signature | ✗ | ToolingExtension
268+
269+
### Wire Format Feature
270+
271+
| Name | Supported | Defined By |
272+
|----------|-----------|------------------|
273+
| JSON | ✓ | OAS2,OAS3
274+
| XML | ✓ | OAS2,OAS3
275+
| PROTOBUF | ✗ | ToolingExtension
276+
| Custom | ✗ | OAS2,OAS3

0 commit comments

Comments
 (0)