mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-12 12:40:53 +00:00
27 lines
38 KiB
HTML
27 lines
38 KiB
HTML
<!doctype html>
|
|
<html lang="en" dir="ltr" class="plugin-pages plugin-id-default">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="generator" content="Docusaurus v2.3.1">
|
|
<title data-rh="true">Hello from OpenAPI Generator | OpenAPI Generator</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-rh="true" name="twitter:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-rh="true" property="og:url" content="https://openapi-generator.tech/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Hello from OpenAPI Generator | OpenAPI Generator"><meta data-rh="true" name="description" content="Description will go into a meta tag in <head />"><meta data-rh="true" property="og:description" content="Description will go into a meta tag in <head />"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://openapi-generator.tech/"><link data-rh="true" rel="alternate" href="https://openapi-generator.tech/" hreflang="en"><link data-rh="true" rel="alternate" href="https://openapi-generator.tech/" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://51ITDG8FYN-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true">function maybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}function insertBanner(){var n=document.getElementById("docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';var e=document.getElementById("docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenAPI Generator RSS Feed">
|
|
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenAPI Generator Atom Feed">
|
|
|
|
<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="search" type="application/opensearchdescription+xml" title="OpenAPI Generator" href="/opensearch.xml">
|
|
<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><link rel="stylesheet" href="/assets/css/styles.fcd3a3ce.css">
|
|
<link rel="preload" href="/assets/js/runtime~main.27a6ef31.js" as="script">
|
|
<link rel="preload" href="/assets/js/main.7f449d5a.js" as="script">
|
|
</head>
|
|
<body class="navigation-with-keyboard">
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
|
<div id="docusaurus-base-url-issue-banner-container"></div><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/mono-logo.svg" alt="OpenAPI Tools logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/mono-logo.svg" alt="OpenAPI Tools logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">OpenAPI Generator</b></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 href="https://api.openapi-generator.tech" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">API</a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><header class="hero hero--primary heroBanner_UJJx"><div class="container"><h1 class="hero__title">OpenAPI Generator</h1><p class="hero__subtitle">Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents</p><div class="buttons_pzbO"><a href="#try" class="button button--outline button--secondary button--lg">Try It Out</a><a class="button button--outline button--secondary button--lg" href="/docs/installation">Install</a></div><div class="buttons_pzbO"><a class="button button--outline button--secondary button--md" href="/docs/generators">Generators</a><a class="button button--outline button--secondary button--md" href="/docs/customization">Customization</a><a class="button button--outline button--secondary button--md" href="/docs/integrations">Integrations</a></div></div></header><div class="announcement_FsS0 announcementDark_tzC4"><div class="announcementInner_RsrQ"><h2><b>Sponsors</b></h2><p>If you find OpenAPI Generator useful, please consider asking your company to <a href="https://opencollective.com/openapi_generator">become a sponsor</a>.</p><p>You can also individually sponsor the project by <a href="https://opencollective.com/openapi_generator">becoming a backer</a>.</p><h3>Thank you to our bronze sponsors!</h3><div class="avatar bronzeSponsorAvatars_lQjW"><a class="avatar__photo-link bronze-sponsor" href="https://www.namsor.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/namsor.png" alt="NamSor" title="NamSor" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.lightbow.net/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/lightbow.png" alt="Lightbow" title="Lightbow" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://docspring.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/docspring.png" alt="DocSpring" title="DocSpring" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://datadoghq.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/datadog.png" alt="Datadog" title="Datadog" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://cpl.thalesgroup.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/thales.jpg" alt="Thales" title="Thales" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.apideck.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/apideck.jpg" alt="Apideck" title="Apideck" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.pexa.com.au/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/pexa.png" alt="PEXA" title="PEXA" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.numary.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/numary.png" alt="Numary" title="Numary" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.onesignal.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/onesignal.png" alt="OneSignal" title="OneSignal" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.virtualansoftware.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/virtualansoftware.png" alt="Virtualan Software" title="Virtualan Software" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.merge.dev/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/mergedev.jpeg" alt="Merge" title="Merge" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.burkert.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/burkert.jpg" alt="Bürkert" title="Bürkert" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.finbourne.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/finbourne.png" alt="FINBOURNE" title="FINBOURNE" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://bump.sh/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/bumpsh.png" alt="Bump.sh" title="Bump.sh" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.bileto.com/?utm_source=openapi_generator&utm_medium=official_website&utm_campaign=sponsor"><img src="/img/companies/bileto.png" alt="bileto" title="bileto" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.bairesdev.com/sponsoring-open-source-projects/"><img src="/img/companies/bairesdev.png" alt="BairesDev" title="BairesDev" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.dmtech.de/"><img src="/img/companies/dmtech.jpeg" alt="dmTECH" title="dmTECH" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://adyen.com/"><img src="/img/companies/adyen.png" alt="Adyen" title="Adyen" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://fornex.com/"><img src="/img/companies/fornex.png" alt="Fornex" title="Fornex" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://runalloy.com/signup?utm_source=github&utm_medium=referral&utm_campaign=1524_openapigenerator"><img src="/img/companies/alloyautomation.png" alt="Alloy Automation" title="Alloy Automation" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://ssstwitter.com/?utm_source=github&utm_medium=referral&utm_campaign=sponsor"><img src="/img/companies/ssstwitter.png" alt="sss Twitter" title="sss Twitter" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.svix.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/svix.png" alt="Svix" title="Svix" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://litslink.com/services/artificial-intelligence/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/litslink.png" alt="LITSLINK" title="LITSLINK" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://designli.co?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/designli.jpg" alt="Designli" title="Designli" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://opensource.muenchen.de/software/openapi-generator.html?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/itm.png" alt="it@m" title="it@m" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://konghq.com/products/kong-konnect?utm_medium=referral&utm_source=github&utm_campaign=platform&utm_content=openapi-generator"><img src="/img/companies/kong.png" alt="Kong" title="Kong" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://route4me.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/route4me.png" alt="Route4Me" title="Route4Me" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.dotcom-monitor.com/sponsoring-open-source-projects/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/dm.png" alt="Dotcom-Monitor" title="Dotcom-Monitor" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://www.clickittech.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/clickit.jpg" alt="ClickIT DevOps & Software Development" title="ClickIT DevOps & Software Development" class="avatar__photo avatar__photo--lg"></a><a class="avatar__photo-link bronze-sponsor" href="https://unified.to/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship"><img src="/img/companies/unified_to.jpg" alt="Unified.to" title="Unified.to" class="avatar__photo avatar__photo--lg"></a></div></div></div><main><section class="features_keug"><div class="features container"><div class="row"><div class="col col--6"><div class="text--center"><img class="featureImage_yA8i" src="/img/icons/plug.svg" alt="logo"></div><h3>Easy to Use</h3><div><p>With <em>50+</em> client generators, you can easily generate code to interact with any server which exposes an OpenAPI document.</p><p>Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs.</p><p>Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates.</p>See <a href="./docs/customization">Customization</a> for details.</div></div><div class="col col--6"><div class="text--center"><img class="featureImage_yA8i" src="/img/icons/exchange.svg" alt="logo"></div><h3>Servers</h3><div><p>Getting started with server development can be tough, especially if you're evaluating technologies. We can reduce the burden when you bring your own OpenAPI document.</p><p>Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP.</p><p>Some generators support <em>Inversion of Control</em>, allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code.</p></div></div><div class="col col--6"><div class="text--center"><img class="featureImage_yA8i" src="/img/icons/pencil.svg" alt="logo"></div><h3>Schemas/Configs</h3><div><p>Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?</p><p>OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators.</p><p>You can easily extend these generators and their templates to create derivative generators!</p></div></div><div class="col col--6"><div class="text--center"><img class="featureImage_yA8i" src="/img/icons/newspaper-o.svg" alt="logo"></div><h3>Documentation</h3><div><p>OpenAPI documents allow you to convert the metadata about your API into some other format.</p><p>We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers.</p><p>We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents.</p></div></div></div></div></section><section class="callout_OSpz"><div class="callout container"><div id="learn" class="row calloutRow_vO4K"><div class="col col--3 blockImage"><img class="image" src="/img/color-logo.svg" alt="learn logo"></div><div class="col col--9"><h2>Learn How</h2><div><span><p>OpenAPI Generator supports many different integrations and use cases, including (but not limited to):</p><ul><li>Maven Plugin</li><li>Gradle Plugin</li><li>Bazel Plugin</li><li>SBT Plugin</li><li>Cake Plugin</li><li>CLI via Homebrew</li><li>CLI via Docker</li><li>CLI via npm</li><li>Generator SaaS</li></ul><p>For details, see <a href="/docs/integrations">Workflow Integrations</a></p><p>Generation also allows for easy customization via options, custom templates, or even custom generators on your classpath. See <a href="/docs/customization">Customization</a> for details.</p></span></div></div></div><div id="connectOnSlack" class="row calloutRow_vO4K"><div class="col col--3 blockImage"><img class="image" src="/img/tools/Slack_Mark-256x256-3a29a6b.png" alt="connectOnSlack logo"></div><div class="col col--9"><h2>Active Community</h2><p><strong>Connect</strong> with us on Slack!</p><p>We're a very community-oriented project. We have an active community of users, contributors, and core team members on Slack. Slack is often a good place to start if you're looking for guidance about where to begin contributing, if you have an idea you're not sure fits the project, or if you just want to ask a question or say hello.</p><p>Slack is free to <a href="https://slack.com/downloads" class="href">download</a>, and our workspace is free to <a href="https://join.slack.com/t/openapi-generator/shared_invite/zt-2wmkn4s8g-n19PJ99Y6Vei74WMUIehQA" class="href">sign up</a>.</p></div></div><div id="try" class="row calloutRow_vO4K"><div class="col col--3 blockImage"><img class="image" src="/img/tools/npm.svg" alt="try logo"></div><div class="col col--9"><h2>Try via npm</h2><p>The <a href="https://github.com/openapitools/openapi-generator-cli" class="href">npm package wrapper</a> is cross-platform wrapper around the .jar artifact.</p><p><strong>Install</strong> globally, exposing the CLI on the command line:</p><p></p><div class="bash language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token comment" style="color:rgb(98, 114, 164)"># install the latest version of "openapi-generator-cli"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token function" style="color:rgb(80, 250, 123)">npm</span><span class="token plain"> </span><span class="token function" style="color:rgb(80, 250, 123)">install</span><span class="token plain"> @openapitools/openapi-generator-cli -g</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token comment" style="color:rgb(98, 114, 164)"># use a specific version of "openapi-generator-cli"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">openapi-generator-cli version-manager </span><span class="token builtin class-name" style="color:rgb(189, 147, 249)">set</span><span class="token plain"> </span><span class="token number">7.12</span><span class="token plain">.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token comment" style="color:rgb(98, 114, 164)"># Or install it as dev-dependency in your node.js projects</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token function" style="color:rgb(80, 250, 123)">npm</span><span class="token plain"> </span><span class="token function" style="color:rgb(80, 250, 123)">install</span><span class="token plain"> @openapitools/openapi-generator-cli -D</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p></p><p>Then, <strong>generate</strong> a ruby client from a valid <a href="https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml" class="href">petstore.yaml</a> doc:</p><p></p><div class="bash language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p></p></div></div><div id="tryHomebrew" class="row calloutRow_vO4K"><div class="col col--3 blockImage"><img class="image" src="/img/tools/homebrew-256x256.png" alt="tryHomebrew logo"></div><div class="col col--9"><h2>Try via Homebrew</h2><p><strong>Install</strong> via <a href="https://brew.sh/" class="href">homebrew</a>:</p><p></p><div class="bash language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">brew </span><span class="token function" style="color:rgb(80, 250, 123)">install</span><span class="token plain"> openapi-generator</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p></p><p>Then, <strong>generate</strong> a ruby client from a valid <a href="https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml" class="href">petstore.yaml</a> doc:</p><p></p><div class="bash language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p></p></div></div><div id="tryDocker" class="row calloutRow_vO4K"><div class="col col--3 blockImage"><img class="image" src="/img/tools/docker.png" alt="tryDocker logo"></div><div class="col col--9"><h2>Try via Docker</h2><p>The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.</p><p>To generate code from a valid <a href="https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml">petstore.yaml</a> doc with this image, you'll need to mount a local location as a volume.</p><p></p><div class="bash language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token function" style="color:rgb(80, 250, 123)">docker</span><span class="token plain"> run --rm </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -v </span><span class="token environment constant" style="color:rgb(189, 147, 249)">$PWD</span><span class="token plain">:/local openapitools/openapi-generator-cli generate </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -i /local/petstore.yaml </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -g go </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -o /local/out/go</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p></p><p>For a full list of our docker images, check out <a href="https://hub.docker.com/u/openapitools">u/openapitools</a> on Docker Hub.</p></div></div></div></section></main><div class="announcement_FsS0 announcementLight_HMMK"><div class="productShowcaseSection_hcFr announcementInner_RsrQ"><h2>Who is Using This?</h2><p>Here are some users of OpenAPI Generator</p><div class="logos"><a href="https://www.askul.co.jp/"><img src="/img/companies/logo-askul-01.gif" alt="ASKUL" title="ASKUL" class="productShowcaseSectionLogo_B5I8"></a><a href="https://www.bithost.ch/"><img src="/img/companies/bithost.svg" alt="Bithost GmbH" title="Bithost GmbH" class="productShowcaseSectionLogo_B5I8"></a><a href="https://www.giantmonkey.de/"><img src="/img/companies/gm.png" alt="Giant Monkey GmbH" title="Giant Monkey GmbH" class="productShowcaseSectionLogo_B5I8"></a><a href="https://www.juststarinfo.com/"><img src="/img/companies/juststar.png" alt="JustStar" title="JustStar" class="productShowcaseSectionLogo_B5I8"></a><a href="https://www.metaswitch.com/"><img src="/img/companies/metaswitch.svg" alt="Metaswitch" title="Metaswitch" class="productShowcaseSectionLogo_B5I8"></a><a href="http://www.stingray.com/"><img src="/img/companies/stingray.png" alt="Stingray" title="Stingray" class="productShowcaseSectionLogo_B5I8"></a><a href="https://dev.telstra.com/"><img src="/img/companies/telstra.svg" alt="Telstra" title="Telstra" class="productShowcaseSectionLogo_B5I8"></a><a href="https://www.unblu.com/"><img src="/img/companies/unblu.svg" alt="unblu inc." title="unblu inc." class="productShowcaseSectionLogo_B5I8"></a><a href="https://wso2.com/"><img src="/img/companies/wso2.png" alt="WSO2" title="WSO2" class="productShowcaseSectionLogo_B5I8"></a><a href="https://www.zalando.com/"><img src="/img/companies/zalando.jpg" alt="Zalando" title="Zalando" class="productShowcaseSectionLogo_B5I8"></a></div><div class="more-users"><a class="button button--outline button--primary button--lg productShowcaseSectionButton_UIEQ" href="/users">More <!-- -->OpenAPI Generator<!-- --> Users</a></div></div></div><div class="announcement_FsS0 announcementDark_tzC4">"OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)</div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><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 class="footer__link-item" href="/docs/integrations">Workflow Integrations</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/users">User Showcase</a></li><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat Room<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/oas_generator" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/OpenAPITools/openapi-generator" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://openapi-generator.tech/" rel="noopener noreferrer" class="footerLogoLink_BH7S"><img src="/img/mono-logo.svg" alt="OpenAPI Tools" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/mono-logo.svg" alt="OpenAPI Tools" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></a></div><div class="footer__copyright">Copyright © 2025 OpenAPI-Generator Contributors (https://openapi-generator.tech)</div></div></div></footer></div>
|
|
<script src="/assets/js/runtime~main.27a6ef31.js"></script>
|
|
<script src="/assets/js/main.7f449d5a.js"></script>
|
|
</body>
|
|
</html> |