forked from loafle/openapi-generator-original
55 lines
19 KiB
HTML
55 lines
19 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width">
|
||
<meta name="generator" content="Docusaurus">
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
|
||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
|
||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||
<script src="https://buttons.github.io/buttons.js"></script>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
|
||
<script src="/js/code-block-buttons.js"></script>
|
||
|
||
<title data-react-helmet="true">Workflow Integrations</title>
|
||
|
||
<meta data-react-helmet="true" http-equiv="x-ua-compatible" content="ie=edge"><meta data-react-helmet="true" property="og:title" content="OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" property="twitter:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" name="twitter:image:alt" content="Image for OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" name="twitter:card" content="summary"><meta data-react-helmet="true" name="description" content="## Workflow Integration (Maven, GitHub, CI/CD)"><meta data-react-helmet="true" property="og:description" content="## Workflow Integration (Maven, GitHub, CI/CD)"><meta data-react-helmet="true" property="og:url" content="https://openapi-generator.tech/docs/integrations">
|
||
|
||
<link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.png">
|
||
|
||
|
||
<link rel="stylesheet" href="/styles.ec5417b5.css">
|
||
|
||
</head>
|
||
<body>
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}function e(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}var n=window.matchMedia("(prefers-color-scheme: dark)");n.addListener((function(n){null===e()&&t(n.matches?"dark":"")}));var a=e();null!==a?t(a):n.matches&&t("dark")}()</script>
|
||
<div id="__docusaurus">
|
||
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a><a class="navbar__item navbar__link" href="/docs/installation">Getting Started</a><a class="navbar__item navbar__link" href="/docs/generators">Generators</a><a class="navbar__item navbar__link" href="/docs/roadmap">Roadmap</a><a class="navbar__item navbar__link" href="/docs/faq">FAQ</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></div><div class="navbar__items navbar__items--right"><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/installation">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/generators">Generators</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/roadmap">Roadmap</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/faq">FAQ</a></li><li class="menu__list-item"><a class="menu__link" href="/team">Team</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a class="menu__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive"><button aria-label="Open Menu" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Getting Started</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/installation">CLI Installation</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/plugins">Plugins</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/online">Online</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/usage">Usage</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/globals">Global Properties</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/configuration">Configuration Options</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/file-post-processing">File post-processing</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Extending</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/templating">Using Templates</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/customization">Customization</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/debugging">Debugging</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active" href="/docs/integrations">Workflow Integrations</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Contributing</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/contributing">Guidelines</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/code-of-conduct">Code of Conduct</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/contribute-building">Building the code</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/new-generator">Create a New Generator</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">About</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/roadmap">Roadmap</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/swagger-codegen-migration">Migrating from Swagger Codegen</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/fork-qna">Swagger Codegen Fork: Q&A</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Releases</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/release-summary">Release Summary</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/release-3-0-0">Release Notes: 3.0.0</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">API</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/generators">Generators List</a></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="padding-vert--lg"><div class="container"><div class="row"><div class="col"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">Workflow Integrations</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="workflow-integration-maven-github-cicd"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#workflow-integration-maven-github-cicd" title="Direct link to heading">#</a>Workflow Integration (Maven, GitHub, CI/CD)</h2><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="gradle-integration"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#gradle-integration" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="maven-integration"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#maven-integration" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="sbt-integration"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#sbt-integration" title="Direct link to heading">#</a>sbt Integration</h3><p>Please refer to <a href="https://github.com/upstart-commerce/sbt-openapi-generator">https://github.com/upstart-commerce/sbt-openapi-generator</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="bazel-integration"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#bazel-integration" title="Direct link to heading">#</a>Bazel Integration</h3><p>Please refer to <a href="https://github.com/OpenAPITools/openapi-generator-bazel">https://github.com/OpenAPITools/openapi-generator-bazel</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="cake-addin"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#cake-addin" title="Direct link to heading">#</a>Cake Addin</h3><p>3rd-party Cake Addin provided by <a href="https://github.com/lukoerfer">Lukas Körfer</a>: <a href="https://github.com/lukoerfer/cake-openapi-generator">https://github.com/lukoerfer/cake-openapi-generator</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="github-integration"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#github-integration" title="Direct link to heading">#</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><p> 1) 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><p> 2) Generate the SDK</p><pre class="mdxCodeBlock_iHAB"><div class="codeBlockWrapper_2QGZ"><pre class="prism-code language-sh codeBlock_19pQ" style="color:#F8F8F2;background-color:#282A36"><div class="token-line" style="color:#F8F8F2"><span class="token plain">java -jar openapi-generator-cli.jar generate \</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain"> -i modules/openapi-generator/src/test/resources/3_0/petstore.json -g perl \</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain"> --git-user-id "wing328" \</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain"> --git-repo-id "petstore-perl" \</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain"> --release-note "GitHub integration demo" \</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain"> -o /var/tmp/perl/petstore</span></div></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button></div></pre><p> 3) Push the SDK to GitHub</p><pre class="mdxCodeBlock_iHAB"><div class="codeBlockWrapper_2QGZ"><pre class="prism-code language-sh codeBlock_19pQ" style="color:#F8F8F2;background-color:#282A36"><div class="token-line" style="color:#F8F8F2"><span class="token plain">cd /var/tmp/perl/petstore</span></div><div class="token-line" style="color:#F8F8F2"><span class="token plain">/bin/sh ./git_push.sh</span></div></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button></div></pre><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="cicd"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#cicd" title="Direct link to heading">#</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></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/integration.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small>Last updated on <time datetime="2020-11-28T07:00:23.000Z" class="docLastUpdatedAt_1sqk">2020-11-28</time> by <strong>Ülgen Sarıkavak</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/debugging"><h5 class="pagination-nav__link--sublabel">Previous</h5><h4 class="pagination-nav__link--label">« Debugging</h4></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/contributing"><h5 class="pagination-nav__link--sublabel">Next</h5><h4 class="pagination-nav__link--label">Guidelines For Contributing »</h4></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="contents contents__left-border"><li><a href="#workflow-integration-maven-github-cicd" class="contents__link">Workflow Integration (Maven, GitHub, CI/CD)</a><ul><li><a href="#gradle-integration" class="contents__link">Gradle Integration</a></li><li><a href="#maven-integration" class="contents__link">Maven Integration</a></li><li><a href="#sbt-integration" class="contents__link">sbt Integration</a></li><li><a href="#bazel-integration" class="contents__link">Bazel Integration</a></li><li><a href="#cake-addin" class="contents__link">Cake Addin</a></li><li><a href="#github-integration" class="contents__link">GitHub Integration</a></li><li><a href="#cicd" class="contents__link">CI/CD</a></li></ul></li></ul></div></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/customization">Customizing Generators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installation</a></li><li class="footer__item"><a aria-current="page" class="footer__link-item active" href="/docs/integrations">Workflow Integrations</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/users">User Showcase</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://stackoverflow.com/questions/tagged/openapi-generator">Stack Overflow</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://twitter.com/oas_generator">Twitter</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://github.com/OpenAPITools/openapi-generator">GitHub</a></li></ul></div></div><div class="text--center"><div class="margin-bottom--sm"><a href="https://openapi-generator.tech/" target="_blank" rel="noopener noreferrer" class="footerLogoLink_1Wg7"><img class="footer__logo" alt="OpenAPI Tools" src="/img/mono-logo.svg"></a></div>Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech)</div></div></footer>
|
||
</div>
|
||
|
||
<script src="/styles.8ca507f6.js"></script>
|
||
|
||
<script src="/runtime~main.f67870b6.js"></script>
|
||
|
||
<script src="/main.e63a9028.js"></script>
|
||
|
||
<script src="/1.fea3cf13.js"></script>
|
||
|
||
<script src="/2.312ccecd.js"></script>
|
||
|
||
<script src="/3.7a8bc6c7.js"></script>
|
||
|
||
<script src="/1be78505.b9ef759e.js"></script>
|
||
|
||
<script src="/20ac7829.25126d58.js"></script>
|
||
|
||
<script src="/17896441.42c7a3f9.js"></script>
|
||
|
||
<script src="/d9b8b8b3.e9de974e.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |