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 1f45ea7d1a
This commit is contained in:
wing328
2019-03-18 14:26:36 +00:00
parent 8226aff8a8
commit 280084d6aa
4 changed files with 50 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/customization/index.html
View File

@@ -215,8 +215,11 @@ TypeScriptNodeClientCodegen.java
<span class="hljs-attr">"apiPackage"</span> : <span class="hljs-string">"petstore"</span>
}
</code></pre>
<p>You can use also <code>config.yml</code> with following equivalent example:</p>
<pre><code class="hljs css language-yaml"><span class="hljs-attr">apiPackage:</span> <span class="hljs-string">"petstore"</span>
</code></pre>
<p>Supported config options can be different per language. Running <code>config-help -g {lang}</code> will show available options.
<strong>These options are applied via configuration file (e.g. config.json) or by passing them with <code>-D{optionName}={optionValue}</code></strong>. (If <code>-D{optionName}</code> does not work, please open a <a href="https://github.com/openapitools/openapi-generator/issues/new">ticket</a> and we'll look into it)</p>
<strong>These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with <code>-D{optionName}={optionValue}</code></strong>. (If <code>-D{optionName}</code> does not work, please open a <a href="https://github.com/openapitools/openapi-generator/issues/new">ticket</a> and we'll look into it)</p>
<pre><code class="hljs css language-sh">java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java
</code></pre>
<p>Output</p>
@@ -246,6 +249,12 @@ TypeScriptNodeClientCodegen.java
<span class="hljs-attr">"library"</span>:<span class="hljs-string">"feign"</span>
}
</code></pre>
<p>Or if you preffer yaml format it can look like</p>
<pre><code class="hljs css language-yaml"><span class="hljs-attr">groupId:</span> <span class="hljs-string">"com.my.company"</span>
<span class="hljs-attr">artifactId:</span> <span class="hljs-string">"MyClient"</span>
<span class="hljs-attr">artifactVersion:</span> <span class="hljs-string">"1.2.0"</span>
<span class="hljs-attr">library:</span> <span class="hljs-string">"feign"</span>
</code></pre>
<p>For all the unspecified options default values will be used.</p>
<p>Another way to override default options is to extend the config class for the specific language.
To change, for example, the prefix for the Objective-C generated files, simply subclass the <code>ObjcClientCodegen.java</code>:</p>
@@ -276,4 +285,4 @@ refer back to your classes. Note, this may not apply to all languages...</p>
<p>or</p>
<pre><code class="hljs">--import-mappings Pet=my<span class="hljs-selector-class">.models</span><span class="hljs-selector-class">.MyPet</span> --import-mappings Order=my<span class="hljs-selector-class">.models</span><span class="hljs-selector-class">.MyOrder</span>
</code></pre>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-3-8</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/templating"><span class="arrow-prev">← </span><span>Using Templates</span></a><a class="docs-next button" href="/docs/debugging"><span>Debugging</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#creating-a-new-template">Creating a new template</a><ul class="toc-headings"><li><a href="#use-your-new-generator-with-the-cli">Use your new generator with the CLI</a></li><li><a href="#use-your-new-generator-with-the-maven-plugin">Use your new generator with the maven plugin</a></li></ul></li><li><a href="#selective-generation">Selective generation</a></li><li><a href="#ignore-file-format">Ignore file format</a></li><li><a href="#customizing-the-generator">Customizing the generator</a></li><li><a href="#bringing-your-own-models">Bringing your own models</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://gitter.im/OpenAPITools/openapi-generator">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 © 2019 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 2019-3-18</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/templating"><span class="arrow-prev">← </span><span>Using Templates</span></a><a class="docs-next button" href="/docs/debugging"><span>Debugging</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#creating-a-new-template">Creating a new template</a><ul class="toc-headings"><li><a href="#use-your-new-generator-with-the-cli">Use your new generator with the CLI</a></li><li><a href="#use-your-new-generator-with-the-maven-plugin">Use your new generator with the maven plugin</a></li></ul></li><li><a href="#selective-generation">Selective generation</a></li><li><a href="#ignore-file-format">Ignore file format</a></li><li><a href="#customizing-the-generator">Customizing the generator</a></li><li><a href="#bringing-your-own-models">Bringing your own models</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://gitter.im/OpenAPITools/openapi-generator">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 © 2019 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>