loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-03 00:43:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deploy website

Browse Source 
Deploy website version based on 47473401ec
This commit is contained in:
wing328
2019-11-21 11:06:11 +00:00
parent 9f6c6339ba
commit be3d3e7e1c
316 changed files with 413 additions and 413 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/faq-generators.html
View File

@@ -68,7 +68,7 @@
};
}
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">FAQ: Generators</h1></header><article><div><span><h3><a class="anchor" aria-hidden="true" id="what-are-some-server-generator-use-cases"></a><a href="#what-are-some-server-generator-use-cases" 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>What are some server generator use cases?</h3>
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">FAQ: Generators</h1></header><article><div><span><h3><a class="anchor" aria-hidden="true" id="what-are-some-server-generator-use-cases"></a><a href="#what-are-some-server-generator-use-cases" 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>What are some server generator use cases?</h3>
<p>We have around 40+ server generators, with more added regularly. Some of these include Spring in your choice of Java or Kotlin, the Finch and Scalatra frameworks using Scala, and C# generators for NancyFX and WebAPI (to name only a few).</p>
<p>Besides generating the server code as a starting point to implement the API backend, here are some use cases of the server generators:</p>
<ul>
@@ -108,7 +108,7 @@ java -jar modules<span class="hljs-regexp">/openapi-generator-cli/</span>target<
</code></pre>
<p>We do <strong>not</strong> recommend using the default HTTP library (Apache HttpClient) with <code>android</code> as it's not actively maintained.</p>
<h2><a class="anchor" aria-hidden="true" id="c-sharp"></a><a href="#c-sharp" 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>C-Sharp</h2>
<h3><a class="anchor" aria-hidden="true" id="how-do-i-fix-csc-warning-cs2002-in-xamarin"></a><a href="#how-do-i-fix-csc-warning-cs2002-in-xamarin" 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>How do I fix <code>CSC: warning CS2002</code> in Xamarin?</h3>
<h3><a class="anchor" aria-hidden="true" id="how-do-i-fix-csc--warning-cs2002-in-xamarin"></a><a href="#how-do-i-fix-csc--warning-cs2002-in-xamarin" 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>How do I fix <code>CSC: warning CS2002</code> in Xamarin?</h3>
<p>The full warning might look like this: <code>CSC: warning CS2002: Source file 'Api/FakeApi.cs' specified multiple times</code></p>
<p>The warning has no impact on the build process so you should be able to build the solution without issue. The warning should be addressed in the upcoming stable release of Xamarin.</p>
<h2><a class="anchor" aria-hidden="true" id="objective-c"></a><a href="#objective-c" 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>Objective-C</h2>
@@ -139,4 +139,4 @@ mvn integration-test
<pre><code class="hljs"> modelPropertyNaming
Naming convention <span class="hljs-keyword">for</span> the <span class="hljs-keyword">property</span>: <span class="hljs-string">'camelCase'</span>, <span class="hljs-string">'PascalCase'</span>, <span class="hljs-string">'snake_case'</span> <span class="hljs-keyword">and</span> <span class="hljs-string">'original'</span>, which keeps the original <span class="hljs-keyword">name</span> (<span class="hljs-keyword">Default</span>: camelCase)
</code></pre>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-11-12</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/faq-contributing"><span class="arrow-prev">← </span><span>FAQ: Contributing</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#java">Java</a><ul class="toc-headings"><li><a href="#the-api-client-has-ssl-errors-due-to-an-invalid-certificate-is-there-a-way-to-bypass-that">The API client has SSL errors due to an invalid certificate. Is there a way to bypass that?</a></li><li><a href="#how-can-i-customize-the-feign-client-templates">How can I customize the Feign client templates?</a></li></ul></li><li><a href="#android">Android</a><ul class="toc-headings"><li><a href="#how-can-i-generate-an-android-sdk">How can I generate an Android SDK?</a></li></ul></li><li><a href="#c-sharp">C-Sharp</a><ul class="toc-headings"><li><a href="#how-do-i-fix-csc-warning-cs2002-in-xamarin">How do I fix <code>CSC: warning CS2002</code> in Xamarin?</a></li></ul></li><li><a href="#objective-c">Objective-C</a><ul class="toc-headings"><li><a href="#how-do-i-run-integration-test-with-petstore-objc-api-client">How do I run integration test with Petstore ObjC API client?</a></li></ul></li><li><a href="#swift">Swift</a><ul class="toc-headings"><li><a href="#how-do-i-run-integration-test-with-petstore-swift-api-client">How do I run integration test with Petstore Swift API client?</a></li><li><a href="#is-swift-2x-generator-still-actively-maintained">Is Swift (2.x) generator still actively maintained?</a></li></ul></li><li><a href="#typescript">TypeScript</a><ul class="toc-headings"><li><a href="#the-json-response-fails-to-deserialize-due-to-change-in-variable-naming-snake_case-to-camelcase-is-there-any-way-to-keep-the-original-naming">The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?</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://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 © 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-11-12</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/faq-contributing"><span class="arrow-prev">← </span><span>FAQ: Contributing</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#java">Java</a><ul class="toc-headings"><li><a href="#the-api-client-has-ssl-errors-due-to-an-invalid-certificate-is-there-a-way-to-bypass-that">The API client has SSL errors due to an invalid certificate. Is there a way to bypass that?</a></li><li><a href="#how-can-i-customize-the-feign-client-templates">How can I customize the Feign client templates?</a></li></ul></li><li><a href="#android">Android</a><ul class="toc-headings"><li><a href="#how-can-i-generate-an-android-sdk">How can I generate an Android SDK?</a></li></ul></li><li><a href="#c-sharp">C-Sharp</a><ul class="toc-headings"><li><a href="#how-do-i-fix-csc--warning-cs2002-in-xamarin">How do I fix <code>CSC: warning CS2002</code> in Xamarin?</a></li></ul></li><li><a href="#objective-c">Objective-C</a><ul class="toc-headings"><li><a href="#how-do-i-run-integration-test-with-petstore-objc-api-client">How do I run integration test with Petstore ObjC API client?</a></li></ul></li><li><a href="#swift">Swift</a><ul class="toc-headings"><li><a href="#how-do-i-run-integration-test-with-petstore-swift-api-client">How do I run integration test with Petstore Swift API client?</a></li><li><a href="#is-swift-2x-generator-still-actively-maintained">Is Swift (2.x) generator still actively maintained?</a></li></ul></li><li><a href="#typescript">TypeScript</a><ul class="toc-headings"><li><a href="#the-json-response-fails-to-deserialize-due-to-change-in-variable-naming-snake_case-to-camelcase-is-there-any-way-to-keep-the-original-naming">The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?</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://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 © 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>