forked from loafle/openapi-generator-original
Deploy website
Deploy website version based on 1f45ea7d1a0b63da18b0f46e3a3b55a2ecc83eef
This commit is contained in:
parent
8226aff8a8
commit
280084d6aa
@ -215,8 +215,11 @@ TypeScriptNodeClientCodegen.java
|
|||||||
<span class="hljs-attr">"apiPackage"</span> : <span class="hljs-string">"petstore"</span>
|
<span class="hljs-attr">"apiPackage"</span> : <span class="hljs-string">"petstore"</span>
|
||||||
}
|
}
|
||||||
</code></pre>
|
</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.
|
<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
|
<pre><code class="hljs css language-sh">java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Output</p>
|
<p>Output</p>
|
||||||
@ -246,6 +249,12 @@ TypeScriptNodeClientCodegen.java
|
|||||||
<span class="hljs-attr">"library"</span>:<span class="hljs-string">"feign"</span>
|
<span class="hljs-attr">"library"</span>:<span class="hljs-string">"feign"</span>
|
||||||
}
|
}
|
||||||
</code></pre>
|
</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>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.
|
<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>
|
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>
|
<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>
|
<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>
|
</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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" 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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
@ -215,8 +215,11 @@ TypeScriptNodeClientCodegen.java
|
|||||||
<span class="hljs-attr">"apiPackage"</span> : <span class="hljs-string">"petstore"</span>
|
<span class="hljs-attr">"apiPackage"</span> : <span class="hljs-string">"petstore"</span>
|
||||||
}
|
}
|
||||||
</code></pre>
|
</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.
|
<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
|
<pre><code class="hljs css language-sh">java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Output</p>
|
<p>Output</p>
|
||||||
@ -246,6 +249,12 @@ TypeScriptNodeClientCodegen.java
|
|||||||
<span class="hljs-attr">"library"</span>:<span class="hljs-string">"feign"</span>
|
<span class="hljs-attr">"library"</span>:<span class="hljs-string">"feign"</span>
|
||||||
}
|
}
|
||||||
</code></pre>
|
</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>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.
|
<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>
|
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>
|
<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>
|
<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>
|
</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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" 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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
@ -448,7 +448,7 @@ SYNOPSIS
|
|||||||
<pre><code class="hljs css language-bash">--import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User
|
<pre><code class="hljs css language-bash">--import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h4><a class="anchor" aria-hidden="true" id="configuration-file"></a><a href="#configuration-file" 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>Configuration File</h4>
|
<h4><a class="anchor" aria-hidden="true" id="configuration-file"></a><a href="#configuration-file" 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>Configuration File</h4>
|
||||||
<p>Rather than passing generator options in a CSV of <code>--additional-properties</code>, you may also provide the settings via JSON file.</p>
|
<p>Rather than passing generator options in a CSV of <code>--additional-properties</code>, you may also provide the settings via JSON file or YAML file.</p>
|
||||||
<p>For example, one of our typescript samples has the following configuration file:</p>
|
<p>For example, one of our typescript samples has the following configuration file:</p>
|
||||||
<pre><code class="hljs css language-json">{
|
<pre><code class="hljs css language-json">{
|
||||||
<span class="hljs-attr">"npmName"</span>: <span class="hljs-string">"@swagger/typescript-fetch-petstore"</span>,
|
<span class="hljs-attr">"npmName"</span>: <span class="hljs-string">"@swagger/typescript-fetch-petstore"</span>,
|
||||||
@ -462,4 +462,16 @@ SYNOPSIS
|
|||||||
<pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
|
<pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
|
||||||
-c config.json
|
-c config.json
|
||||||
</code></pre>
|
</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/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/general-faq"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</a></li></ul></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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
<p>Same configuration file can be passed into YAML format having following equivalent content:</p>
|
||||||
|
<pre><code class="hljs css language-yaml"><span class="hljs-attr">npmName:</span> <span class="hljs-string">"@swagger/typescript-fetch-petstore"</span>
|
||||||
|
<span class="hljs-attr">npmVersion:</span> <span class="hljs-string">"1.0.0"</span>
|
||||||
|
<span class="hljs-attr">npmRepository:</span> <span class="hljs-string">"https://skimdb.npmjs.com/registry"</span>
|
||||||
|
<span class="hljs-attr">snapshot:</span> <span class="hljs-literal">false</span>
|
||||||
|
<span class="hljs-attr">supportsES6:</span> <span class="hljs-literal">true</span>
|
||||||
|
</code></pre>
|
||||||
|
<p>The settings are passed exactly the same as for <code>config.json</code>. The most important part is the file extension. Supported values are <code>yml</code> or <code>yaml</code>.
|
||||||
|
The name of the file should be <code>config.yml</code> or <code>config.yaml</code> (in our example it will be <code>config.yaml</code>.</p>
|
||||||
|
<pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
|
||||||
|
-c config.yaml
|
||||||
|
</code></pre>
|
||||||
|
</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/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/general-faq"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</a></li></ul></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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
@ -448,7 +448,7 @@ SYNOPSIS
|
|||||||
<pre><code class="hljs css language-bash">--import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User
|
<pre><code class="hljs css language-bash">--import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h4><a class="anchor" aria-hidden="true" id="configuration-file"></a><a href="#configuration-file" 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>Configuration File</h4>
|
<h4><a class="anchor" aria-hidden="true" id="configuration-file"></a><a href="#configuration-file" 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>Configuration File</h4>
|
||||||
<p>Rather than passing generator options in a CSV of <code>--additional-properties</code>, you may also provide the settings via JSON file.</p>
|
<p>Rather than passing generator options in a CSV of <code>--additional-properties</code>, you may also provide the settings via JSON file or YAML file.</p>
|
||||||
<p>For example, one of our typescript samples has the following configuration file:</p>
|
<p>For example, one of our typescript samples has the following configuration file:</p>
|
||||||
<pre><code class="hljs css language-json">{
|
<pre><code class="hljs css language-json">{
|
||||||
<span class="hljs-attr">"npmName"</span>: <span class="hljs-string">"@swagger/typescript-fetch-petstore"</span>,
|
<span class="hljs-attr">"npmName"</span>: <span class="hljs-string">"@swagger/typescript-fetch-petstore"</span>,
|
||||||
@ -462,4 +462,16 @@ SYNOPSIS
|
|||||||
<pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
|
<pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
|
||||||
-c config.json
|
-c config.json
|
||||||
</code></pre>
|
</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/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/general-faq"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</a></li></ul></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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
<p>Same configuration file can be passed into YAML format having following equivalent content:</p>
|
||||||
|
<pre><code class="hljs css language-yaml"><span class="hljs-attr">npmName:</span> <span class="hljs-string">"@swagger/typescript-fetch-petstore"</span>
|
||||||
|
<span class="hljs-attr">npmVersion:</span> <span class="hljs-string">"1.0.0"</span>
|
||||||
|
<span class="hljs-attr">npmRepository:</span> <span class="hljs-string">"https://skimdb.npmjs.com/registry"</span>
|
||||||
|
<span class="hljs-attr">snapshot:</span> <span class="hljs-literal">false</span>
|
||||||
|
<span class="hljs-attr">supportsES6:</span> <span class="hljs-literal">true</span>
|
||||||
|
</code></pre>
|
||||||
|
<p>The settings are passed exactly the same as for <code>config.json</code>. The most important part is the file extension. Supported values are <code>yml</code> or <code>yaml</code>.
|
||||||
|
The name of the file should be <code>config.yml</code> or <code>config.yaml</code> (in our example it will be <code>config.yaml</code>.</p>
|
||||||
|
<pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
|
||||||
|
-c config.yaml
|
||||||
|
</code></pre>
|
||||||
|
</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/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/general-faq"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</a></li></ul></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 "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
Loading…
x
Reference in New Issue
Block a user