forked from loafle/openapi-generator-original
64 lines
16 KiB
HTML
64 lines
16 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Workflow Integrations · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<h2><a class="anchor" aria-hidden="true" id="workflow-integration-maven-github-ci-cd"></a><a href="#workflow-integration-maven-github-ci-cd" 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>Workflow Integration (Maven, Github, CI/CD)</h2>
|
||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Workflow Integrations · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://OpenAPITools.github.io/openapi-generator/index.html"/><meta property="og:description" content="<h2><a class="anchor" aria-hidden="true" id="workflow-integration-maven-github-ci-cd"></a><a href="#workflow-integration-maven-github-ci-cd" 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>Workflow Integration (Maven, Github, CI/CD)</h2>
|
||
"/><meta property="og:image" content="https://OpenAPITools.github.io/openapi-generator/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://OpenAPITools.github.io/openapi-generator/img/icons/twitter.svg"/><link rel="shortcut icon" href="/openapi-generator/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://OpenAPITools.github.io/openapi-generator/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://OpenAPITools.github.io/openapi-generator/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><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="/openapi-generator/js/code-block-buttons.js"></script><link rel="stylesheet" href="/openapi-generator/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/openapi-generator/"><img class="logo" src="/openapi-generator/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="/openapi-generator/docs/installation" target="_self">Get Started</a></li><li class="siteNavGroupActive"><a href="/openapi-generator/docs/generators" target="_self">Generators</a></li><li class="siteNavGroupActive"><a href="/openapi-generator/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/openapi-generator/team" target="_self">Team</a></li><li class=""><a href="/openapi-generator/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/openapi-generator/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Extending</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><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/installation">CLI Installation</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/plugins">Plugins</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/online">Online</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/usage">Usage</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Extending</h3><ul><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/templating">Using Templates</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/customization">Customization</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/debugging">Debugging</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/openapi-generator/docs/integrations">Workflow Integrations</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Contributing</h3><ul><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/contributing">Guidelines</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/code-of-conduct">Code of Conduct</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/contribute-building">Building the code</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/new-generator">Create a New Generator</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">About</h3><ul><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/roadmap">Roadmap</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/swagger-codegen-migration">Migrating from Swagger Codegen</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/fork-qna">Swagger Codegen Fork: Q&A</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Releases</h3><ul><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/release-summary">Release Summary</a></li><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/release-3-0-0">Release Notes: 3.0.0</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">API</h3><ul><li class="navListItem"><a class="navItem" href="/openapi-generator/docs/generators">Generators List</a></li></ul></div></div></section></div><script>
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
const headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
if (event.target.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
}
|
||
}, 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">Workflow Integrations</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="workflow-integration-maven-github-ci-cd"></a><a href="#workflow-integration-maven-github-ci-cd" 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>Workflow Integration (Maven, Github, CI/CD)</h2>
|
||
<h3><a class="anchor" aria-hidden="true" id="gradle-integration"></a><a href="#gradle-integration" 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>Gradle Integration</h3>
|
||
<p>See the <a href="https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc">openapi-generator-gradle-plugin README</a> for details related to configuring and using the Gradle Plugin.</p>
|
||
<p>Supported tasks include:</p>
|
||
<ul>
|
||
<li>Listing generators</li>
|
||
<li>Validation of Open API 2.0 and 3.0 Specs</li>
|
||
<li>Generating "Meta" generators</li>
|
||
<li>Generating all generators supported by OpenAPI Generator</li>
|
||
</ul>
|
||
<h3><a class="anchor" aria-hidden="true" id="maven-integration"></a><a href="#maven-integration" 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>Maven Integration</h3>
|
||
<p>See the <a href="https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md">openapi-generator-maven-plugin README</a> for details related to configuring and using the Maven Plugin.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="github-integration"></a><a href="#github-integration" 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>GitHub Integration</h3>
|
||
<p>To push the auto-generated SDK to GitHub, we provide <code>git_push.sh</code> to streamline the process. For example:</p>
|
||
<ol>
|
||
<li><p>Create a new repository in GitHub (Ref: <a href="https://help.github.com/articles/creating-a-new-repository/">https://help.github.com/articles/creating-a-new-repository/</a>)</p></li>
|
||
<li><p>Generate the SDK</p></li>
|
||
</ol>
|
||
<pre><code class="hljs css language-sh"> java -jar openapi-generator-cli.jar generate \
|
||
-i modules/openapi-generator/src/<span class="hljs-built_in">test</span>/resources/2_0/petstore.json -g perl \
|
||
--git-user-id <span class="hljs-string">"wing328"</span> \
|
||
--git-repo-id <span class="hljs-string">"petstore-perl"</span> \
|
||
--release-note <span class="hljs-string">"Github integration demo"</span> \
|
||
-o /var/tmp/perl/petstore
|
||
</code></pre>
|
||
<ol start="3">
|
||
<li>Push the SDK to GitHub</li>
|
||
</ol>
|
||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> /var/tmp/perl/petstore
|
||
/bin/sh ./git_push.sh
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="ci-cd"></a><a href="#ci-cd" 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>CI/CD</h3>
|
||
<p>Some generators also generate CI/CD configuration files (.travis.yml) so that the output will be ready to be tested by the CI (e.g. Travis)</p>
|
||
<p>If you're looking for the configuration files of a particular CI that is not yet supported, please open an <a href="https://github.com/openapitools/openapi-generator/issues/new">issue</a> to let us know.</p>
|
||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-1-18</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/openapi-generator/docs/debugging"><span class="arrow-prev">← </span><span>Debugging</span></a><a class="docs-next button" href="/openapi-generator/docs/contributing"><span>Guidelines</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#workflow-integration-maven-github-ci-cd">Workflow Integration (Maven, Github, CI/CD)</a><ul class="toc-headings"><li><a href="#gradle-integration">Gradle Integration</a></li><li><a href="#maven-integration">Maven Integration</a></li><li><a href="#github-integration">GitHub Integration</a></li><li><a href="#ci-cd">CI/CD</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/openapi-generator/" class="nav-home"><img src="/openapi-generator/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/openapi-generator/docs/en/customization.html">Customizing Generators</a><a href="/openapi-generator/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/openapi-generator/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">Project Chat</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/openapi-generator/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="attribution"><a href="https://code.facebook.com/projects/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/openapi-generator/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><a href="https://fontawesome.com/license/free" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/openapi-generator/img/fa-logo.svg" alt="Fontawesome (Free)" width="170" height="45"/></a></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)</section></footer></div></body></html> |