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

Deploy website

Browse Source 
Deploy website version based on 644f720db8
This commit is contained in:
wing328
2020-01-20 01:52:37 +00:00
parent f6fc1bfd84
commit eb62a9c521
311 changed files with 18231 additions and 18869 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
docs/generators/javascript.html
View File

@@ -17,28 +17,28 @@
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
</thead>
<tbody>
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>null</td></tr>
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>null</td></tr>
<tr><td>projectName</td><td>name of the project (Default: generated from info.title or &quot;openapi-js-client&quot;)</td><td></td><td>null</td></tr>
<tr><td>moduleName</td><td>module name for AMD, Node or globals (Default: generated from &lt;projectName&gt;)</td><td></td><td>null</td></tr>
<tr><td>projectDescription</td><td>description of the project (Default: using info.description or &quot;Client library of &lt;projectName&gt;&quot;)</td><td></td><td>null</td></tr>
<tr><td>projectVersion</td><td>version of the project (Default: using info.version or &quot;1.0.0&quot;)</td><td></td><td>null</td></tr>
<tr><td>licenseName</td><td>name of the license the project uses (Default: using info.license.name)</td><td></td><td>null</td></tr>
<tr><td>usePromises</td><td>use Promises as return values from the client API, instead of superagent callbacks</td><td></td><td>false</td></tr>
<tr><td>emitModelMethods</td><td>generate getters and setters for model properties</td><td></td><td>false</td></tr>
<tr><td>emitJSDoc</td><td>generate JSDoc comments</td><td></td><td>true</td></tr>
<tr><td>useInheritance</td><td>use JavaScript prototype chains &amp; delegation for inheritance</td><td></td><td>true</td></tr>
<tr><td>emitModelMethods</td><td>generate getters and setters for model properties</td><td></td><td>false</td></tr>
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
<tr><td>useES6</td><td>use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.</td><td></td><td>true</td></tr>
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
<tr><td>licenseName</td><td>name of the license the project uses (Default: using info.license.name)</td><td></td><td>null</td></tr>
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>null</td></tr>
<tr><td>modelPropertyNaming</td><td>Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name</td><td></td><td>camelCase</td></tr>
<tr><td>moduleName</td><td>module name for AMD, Node or globals (Default: generated from &lt;projectName&gt;)</td><td></td><td>null</td></tr>
<tr><td>npmRepository</td><td>Use this property to set an url your private npmRepo in the package.json</td><td></td><td>null</td></tr>
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
<tr><td>projectDescription</td><td>description of the project (Default: using info.description or &quot;Client library of &lt;projectName&gt;&quot;)</td><td></td><td>null</td></tr>
<tr><td>projectName</td><td>name of the project (Default: generated from info.title or &quot;openapi-js-client&quot;)</td><td></td><td>null</td></tr>
<tr><td>projectVersion</td><td>version of the project (Default: using info.version or &quot;1.0.0&quot;)</td><td></td><td>null</td></tr>
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
<tr><td>useES6</td><td>use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.</td><td></td><td>true</td></tr>
<tr><td>useInheritance</td><td>use JavaScript prototype chains &amp; delegation for inheritance</td><td></td><td>true</td></tr>
<tr><td>usePromises</td><td>use Promises as return values from the client API, instead of superagent callbacks</td><td></td><td>false</td></tr>
</tbody>
</table>
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
@@ -63,92 +63,92 @@
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Array</li>
<li>Blob</li>
<li>Boolean</li>
<li>Date</li>
<li>File</li>
<li>Number</li>
<li>Object</li>
<li>String</li>
<li>Boolean</li>
<li>File</li>
<li>Date</li>
</ul>
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>date</li>
<li>synchronized</li>
<li>debugger</li>
<li>isfinite</li>
<li>do</li>
<li>float</li>
<li>while</li>
<li>hasownproperty</li>
<li>number</li>
<li>protected</li>
<li>continue</li>
<li>else</li>
<li>function</li>
<li>let</li>
<li>nan</li>
<li>catch</li>
<li>export</li>
<li>if</li>
<li>case</li>
<li>new</li>
<li>package</li>
<li>static</li>
<li>void</li>
<li>in</li>
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
<li>arguments</li>
<li>array</li>
<li>boolean</li>
<li>break</li>
<li>byte</li>
<li>case</li>
<li>catch</li>
<li>char</li>
<li>class</li>
<li>const</li>
<li>continue</li>
<li>date</li>
<li>debugger</li>
<li>default</li>
<li>delete</li>
<li>do</li>
<li>double</li>
<li>var</li>
<li>finally</li>
<li>this</li>
<li>isprototypeof</li>
<li>throws</li>
<li>else</li>
<li>enum</li>
<li>eval</li>
<li>export</li>
<li>extends</li>
<li>null</li>
<li>transient</li>
<li>false</li>
<li>final</li>
<li>finally</li>
<li>float</li>
<li>for</li>
<li>function</li>
<li>goto</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>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>
<li>prototype</li>
<li>public</li>
<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>transient</li>
<li>true</li>
<li>try</li>
<li>math</li>
<li>object</li>
<li>implements</li>
<li>private</li>
<li>const</li>
<li>import</li>
<li>string</li>
<li>valueof</li>
<li>for</li>
<li>interface</li>
<li>isnan</li>
<li>delete</li>
<li>long</li>
<li>switch</li>
<li>undefined</li>
<li>default</li>
<li>goto</li>
<li>public</li>
<li>native</li>
<li>array</li>
<li>yield</li>
<li>class</li>
<li>typeof</li>
<li>break</li>
<li>false</li>
<li>undefined</li>
<li>valueof</li>
<li>var</li>
<li>void</li>
<li>volatile</li>
<li>abstract</li>
<li>prototype</li>
<li>int</li>
<li>instanceof</li>
<li>super</li>
<li>while</li>
<li>with</li>
<li>boolean</li>
<li>throw</li>
<li>char</li>
<li>short</li>
<li>arguments</li>
<li>infinity</li>
<li>tostring</li>
<li>return</li>
<li>yield</li>
</ul>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 1/10/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 1/20/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>