forked from loafle/openapi-generator-original
176 lines
18 KiB
HTML
176 lines
18 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Online · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Hosted"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Online · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="## Hosted"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-132927057-1', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/installation" target="_self">Get Started</a></li><li class="siteNavGroupActive"><a href="/docs/generators" target="_self">Generators</a></li><li class="siteNavGroupActive"><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Getting Started</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/installation">CLI Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/plugins">Plugins</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/online">Online</a></li><li class="navListItem"><a class="navItem" href="/docs/usage">Usage</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Extending</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/templating">Using Templates</a></li><li class="navListItem"><a class="navItem" href="/docs/customization">Customization</a></li><li class="navListItem"><a class="navItem" href="/docs/debugging">Debugging</a></li><li class="navListItem"><a class="navItem" href="/docs/integrations">Workflow Integrations</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Contributing</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/contributing">Guidelines</a></li><li class="navListItem"><a class="navItem" href="/docs/code-of-conduct">Code of Conduct</a></li><li class="navListItem"><a class="navItem" href="/docs/contribute-building">Building the code</a></li><li class="navListItem"><a class="navItem" href="/docs/new-generator">Create a New Generator</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">About</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/roadmap">Roadmap</a></li><li class="navListItem"><a class="navItem" href="/docs/swagger-codegen-migration">Migrating from Swagger Codegen</a></li><li class="navListItem"><a class="navItem" href="/docs/fork-qna">Swagger Codegen Fork: Q&A</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Releases</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/release-summary">Release Summary</a></li><li class="navListItem"><a class="navItem" href="/docs/release-3-0-0">Release Notes: 3.0.0</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">API</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/generators">Generators List</a></li></ul></div></div></section></div><script>
|
||
var coll = document.getElementsByClassName('collapsible');
|
||
var checkActiveCategory = true;
|
||
for (var i = 0; i < coll.length; i++) {
|
||
var links = coll[i].nextElementSibling.getElementsByTagName('*');
|
||
if (checkActiveCategory){
|
||
for (var j = 0; j < links.length; j++) {
|
||
if (links[j].classList.contains('navListItemActive')){
|
||
coll[i].nextElementSibling.classList.toggle('hide');
|
||
coll[i].childNodes[1].classList.toggle('rotate');
|
||
checkActiveCategory = false;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
coll[i].addEventListener('click', function() {
|
||
var arrow = this.childNodes[1];
|
||
arrow.classList.toggle('rotate');
|
||
var content = this.nextElementSibling;
|
||
content.classList.toggle('hide');
|
||
});
|
||
}
|
||
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
var headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
var el = event.target;
|
||
while(el !== headings){
|
||
if (el.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
break;
|
||
} else{
|
||
el = el.parentNode;
|
||
}
|
||
}
|
||
}, false);
|
||
|
||
function createToggler(togglerSelector, targetSelector, className) {
|
||
var toggler = document.querySelector(togglerSelector);
|
||
var target = document.querySelector(targetSelector);
|
||
|
||
if (!toggler) {
|
||
return;
|
||
}
|
||
|
||
toggler.onclick = function(event) {
|
||
event.preventDefault();
|
||
|
||
target.classList.toggle(className);
|
||
};
|
||
}
|
||
});
|
||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">Online</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="hosted"></a><a href="#hosted" 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>Hosted</h2>
|
||
<p>We offer online services, publicly and free of charge:</p>
|
||
<ul>
|
||
<li>latest stable version: <a href="http://api.openapi-generator.tech">http://api.openapi-generator.tech</a></li>
|
||
<li>latest master: <a href="http://api-latest-master.openapi-generator.tech">http://api-latest-master.openapi-generator.tech</a> (updated with latest master every hour)</li>
|
||
</ul>
|
||
<blockquote>
|
||
<p><strong>Hosting Sponsor</strong> <br>
|
||
<a href="https://www.linode.com/"><img src="https://www.linode.com/media/images/logos/standard/light/linode-logo_standard_light_small.png" alt="Linode Logo"></a></p>
|
||
</blockquote>
|
||
<p>These services are beta and do not have any guarantee on service level</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="docker-image"></a><a href="#docker-image" 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>Docker Image</h2>
|
||
<p>The openapi-generator-online Docker image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.</p>
|
||
<p>Example usage:</p>
|
||
<pre><code class="hljs css language-bash"><span class="hljs-comment"># Start container at port 8888 and save the container id</span>
|
||
CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online)
|
||
|
||
<span class="hljs-comment"># allow for startup</span>
|
||
sleep 10
|
||
|
||
<span class="hljs-comment"># Get the IP of the running container (optional)</span>
|
||
GEN_IP=$(docker inspect --format <span class="hljs-string">'{{.NetworkSettings.IPAddress}}'</span> <span class="hljs-variable">${CID}</span>)
|
||
|
||
<span class="hljs-comment"># Execute an HTTP request to generate a Ruby client</span>
|
||
curl -X POST --header <span class="hljs-string">'Content-Type: application/json'</span> \
|
||
--header <span class="hljs-string">'Accept: application/json'</span> \
|
||
-d <span class="hljs-string">'{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}'</span> \
|
||
<span class="hljs-string">'http://localhost:8888/api/gen/clients/ruby'</span>
|
||
|
||
<span class="hljs-comment"># Example output:</span>
|
||
<span class="hljs-comment"># {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}</span>
|
||
|
||
<span class="hljs-comment"># Download the generated zip file (using "code" provided from your output) </span>
|
||
wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8
|
||
|
||
<span class="hljs-comment"># Unzip the file</span>
|
||
unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8
|
||
|
||
<span class="hljs-comment"># Shutdown the openapi generator image</span>
|
||
docker stop <span class="hljs-variable">${CID}</span> && docker rm <span class="hljs-variable">${CID}</span>
|
||
</code></pre>
|
||
<h2><a class="anchor" aria-hidden="true" id="local-self-hosting"></a><a href="#local-self-hosting" 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>Local/Self-hosting</h2>
|
||
<p>If you prefer to run the service locally, here are the steps:</p>
|
||
<pre><code class="hljs css language-bash">mvn clean install
|
||
<span class="hljs-built_in">cd</span> modules/openapi-generator-online
|
||
mvn spring-boot:run
|
||
</code></pre>
|
||
<blockquote>
|
||
<p>The online openapi-generator can be run via <a href="#docker-image">Docker</a> as well.</p>
|
||
</blockquote>
|
||
<p>For example, to generate Ruby API client, simply send the following HTTP request using curl:</p>
|
||
<pre><code class="hljs css language-bash">curl -X POST -H <span class="hljs-string">"content-type:application/json"</span> -d <span class="hljs-string">'{"openAPIUrl":"https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}'</span> \
|
||
http://localhost:8080/api/gen/clients/ruby
|
||
</code></pre>
|
||
<p>Then you will receive a JSON response with the URL to download the zipped code.</p>
|
||
<p>To customize the SDK, you can <code>POST</code> to <code>http://localhost:8080/gen/clients/{generator}</code> with the following HTTP body:</p>
|
||
<pre><code class="hljs css language-json">{
|
||
<span class="hljs-attr">"options"</span>: {},
|
||
<span class="hljs-attr">"openAPIUrl"</span>: <span class="hljs-string">"https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"</span>
|
||
}
|
||
</code></pre>
|
||
<p>Here, the <code>options</code> for a language can be obtained by submitting a <code>GET</code> request to <code>http://locahost:8080/api/gen/clients/{generator}</code>:</p>
|
||
<p>For example, <code>curl http://localhost:8080/api/gen/clients/python</code> returns</p>
|
||
<pre><code class="hljs css language-json"> "packageName":{
|
||
"opt":"packageName",
|
||
"description":"python package name (convention: snake_case).",
|
||
"type":"string",
|
||
"default":"openapi_client"
|
||
},
|
||
"packageVersion":{
|
||
"opt":"packageVersion",
|
||
"description":"python package version.",
|
||
"type":"string",
|
||
"default":"1.0.0"
|
||
},
|
||
"sortParamsByRequiredFlag":{
|
||
"opt":"sortParamsByRequiredFlag",
|
||
"description":"Sort method arguments to place required parameters before optional parameters.",
|
||
"type":"boolean",
|
||
"default":"true"
|
||
}
|
||
|
||
{}
|
||
</code></pre>
|
||
<p>To set package name to <code>pet_store</code>, the HTTP body of the request is as follows:</p>
|
||
<pre><code class="hljs css language-json">{
|
||
<span class="hljs-attr">"options"</span>: {
|
||
<span class="hljs-attr">"packageName"</span>: <span class="hljs-string">"pet_store"</span>
|
||
},
|
||
<span class="hljs-attr">"openAPIUrl"</span>: <span class="hljs-string">"https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"</span>
|
||
}
|
||
</code></pre>
|
||
<p>and here is the curl command:</p>
|
||
<pre><code class="hljs css language-bash">curl -H <span class="hljs-string">"Content-type: application/json"</span> \
|
||
-X POST \
|
||
-d <span class="hljs-string">'{"options": {"packageName": "pet_store"},"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}'</span> \
|
||
http://localhost:8080/api/gen/clients/python
|
||
</code></pre>
|
||
<p>Instead of using <code>openAPIUrl</code> with an URL to the OpenAPI spec, one can include the spec in the JSON payload with <code>spec</code>:</p>
|
||
<pre><code class="hljs css language-json">{
|
||
"options": {},
|
||
"spec": {
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"version": "1.0.0",
|
||
"title": "Test API"
|
||
},
|
||
...
|
||
}
|
||
}
|
||
</code></pre>
|
||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-8-8</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/plugins"><span class="arrow-prev">← </span><span>Plugins</span></a><a class="docs-next button" href="/docs/usage"><span>Usage</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#hosted">Hosted</a></li><li><a href="#docker-image">Docker Image</a></li><li><a href="#local-self-hosting">Local/Self-hosting</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> |