loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

update doc

Browse Source
This commit is contained in:
William Cheng 2022-08-22 18:50:29 +08:00
parent ed10360fc6
commit ff03e1ac8d
2 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generators.md
View File

@ -34,7 +34,7 @@ The following generators are available:
* [java](generators/java.md)
* [java-micronaut-client (beta)](generators/java-micronaut-client.md)
* [javascript](generators/javascript.md)
* [javascript-apollo (beta)](generators/javascript-apollo.md)
* [javascript-apollo](generators/javascript-apollo.md)
* [javascript-closure-angular](generators/javascript-closure-angular.md)
* [javascript-flowtyped](generators/javascript-flowtyped.md)
* [jaxrs-cxf-client](generators/jaxrs-cxf-client.md)

33
docs/generators/javascript-apollo.md
View File

@ -7,7 +7,7 @@ title: Documentation for the javascript-apollo Generator
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | javascript-apollo | pass this to the generate command after -g |
| generator stability | BETA | |
| generator stability | STABLE | |
| generator type | CLIENT | |
| generator language | Javascript | |
| generator default templating engine | mustache | |
@ -22,6 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|apiPackage|package for generated api classes| |null|
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
|emitJSDoc|generate JSDoc comments| |true|
|emitModelMethods|generate getters and setters for model properties| |false|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
@ -40,6 +41,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|sourceFolder|source folder for generated code| |src|
|useInheritance|use JavaScript prototype chains &amp; delegation for inheritance| |true|
|usePromises|use Promises as return values from the client API, instead of superagent callbacks| |false|
## IMPORT MAPPING
@ -54,6 +56,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|array|Array|
|list|Array|
|map|Object|
|set|Array|
## LANGUAGE PRIMITIVES
@ -72,9 +75,16 @@ These options may be applied as additional-properties (cli) or configOptions (pl
## RESERVED WORDS
<ul class="column-ul">
<li>Array</li>
<li>Date</li>
<li>Infinity</li>
<li>Math</li>
<li>NaN</li>
<li>Number</li>
<li>Object</li>
<li>String</li>
<li>abstract</li>
<li>arguments</li>
<li>array</li>
<li>boolean</li>
<li>break</li>
<li>byte</li>
@ -84,7 +94,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
<li>class</li>
<li>const</li>
<li>continue</li>
<li>date</li>
<li>debugger</li>
<li>default</li>
<li>delete</li>
@ -102,27 +111,22 @@ These options may be applied as additional-properties (cli) or configOptions (pl
<li>for</li>
<li>function</li>
<li>goto</li>
<li>hasownproperty</li>
<li>hasOwnProperty</li>
<li>if</li>
<li>implements</li>
<li>import</li>
<li>in</li>
<li>infinity</li>
<li>instanceof</li>
<li>int</li>
<li>interface</li>
<li>isfinite</li>
<li>isnan</li>
<li>isprototypeof</li>
<li>isFinite</li>
<li>isNaN</li>
<li>isPrototypeOf</li>
<li>let</li>
<li>long</li>
<li>math</li>
<li>nan</li>
<li>native</li>
<li>new</li>
<li>null</li>
<li>number</li>
<li>object</li>
<li>package</li>
<li>private</li>
<li>protected</li>
@ -131,20 +135,19 @@ These options may be applied as additional-properties (cli) or configOptions (pl
<li>return</li>
<li>short</li>
<li>static</li>
<li>string</li>
<li>super</li>
<li>switch</li>
<li>synchronized</li>
<li>this</li>
<li>throw</li>
<li>throws</li>
<li>tostring</li>
<li>toString</li>
<li>transient</li>
<li>true</li>
<li>try</li>
<li>typeof</li>
<li>undefined</li>
<li>valueof</li>
<li>valueOf</li>
<li>var</li>
<li>void</li>
<li>volatile</li>