+20 -9

README.md

··· 30 30 31 31 ## Features 32 32 33 33 - - works with CLI, Node.js 18+, or npx 34 34 - - supports OpenAPI 2.0, 3.0, and 3.1 specifications 35 35 - - supports JSON and YAML input files 36 36 - - generates TypeScript interfaces and SDKs 37 37 - - Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available 33 33 + - runs in CLI, Node.js 18+, or npx 34 34 + - works with OpenAPI 2.0, 3.0, and 3.1 35 35 + - customizable types and SDKs 36 36 + - clients for your runtime (Fetch API, Axios, Next.js, Nuxt, etc.) 38 37 - plugin ecosystem to reduce third-party boilerplate 39 39 - - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 38 38 + - custom plugins and custom clients 39 39 + - [integration](https://heyapi.dev/openapi-ts/integrations) with Hey API platform 40 40 + 41 41 + ## Dashboard 40 42 41 41 - ## Platform 43 43 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 42 44 43 43 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 45 45 + [Sign In](https://app.heyapi.dev) to Hey API platform. 44 46 45 47 ## Sponsors 46 48 ··· 177 179 178 180 Clients are responsible for sending the actual HTTP requests. Using clients is not required, but you must add a client to `plugins` if you're generating SDKs (enabled by default). 179 181 180 180 - You can learn more on the [Clients](https://heyapi.dev/openapi-ts/clients) page. 182 182 + ### Native Clients 183 183 + 184 184 + - [`@hey-api/client-fetch](https://heyapi.dev/openapi-ts/clients/fetch) 185 185 + - [`@hey-api/client-axios](https://heyapi.dev/openapi-ts/clients/axios) 186 186 + - [`@hey-api/client-next](https://heyapi.dev/openapi-ts/clients/next-js) 187 187 + - [`@hey-api/client-nuxt](https://heyapi.dev/openapi-ts/clients/nuxt) 188 188 + 189 189 + Don't see your client? [Build your own](https://heyapi.dev/openapi-ts/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 181 190 182 191 ## Plugins 183 192 ··· 221 230 - [Valibot](https://heyapi.dev/openapi-ts/plugins/valibot) 222 231 - [Yup](https://heyapi.dev/openapi-ts/plugins/yup) 223 232 - [Zustand](https://heyapi.dev/openapi-ts/plugins/zustand) 233 233 + 234 234 + Don't see your plugin? [Build your own](https://heyapi.dev/openapi-ts/plugins/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 224 235 225 236 ## Migration Guides 226 237

+7 -5

docs/.vitepress/theme/Layout.vue

··· 8 8 <Layout> 9 9 <template #layout-top> 10 10 <div class="announcement"> 11 11 - <span> 12 12 - Our platform<span class="hide-sm"> for OpenAPI specifications</span> 13 13 - is now available 14 14 - </span> 15 15 - <a href="https://app.heyapi.dev/"> Join Beta </a> 11 11 + <span> Build better APIs with our platform </span> 12 12 + <a 13 13 + href="https://app.heyapi.dev/" 14 14 + rel="noopener noreferrer" 15 15 + target="_blank" 16 16 + >Dashboard</a 17 17 + > 16 18 </div> 17 19 <!-- <div class="announcement"> 18 20 <span>

+7 -21

docs/.vitepress/theme/custom.css

··· 199 199 text-transform: lowercase; 200 200 } 201 201 202 202 - .VPFeatures.VPHomeFeatures { 203 203 - padding: 0; 204 204 - } 205 205 - 206 202 .VPFeatures.VPHomeFeatures > .container { 207 203 max-width: initial; 208 204 } 209 205 210 206 .VPFeatures.VPHomeFeatures > .container > .items { 211 211 - flex-wrap: nowrap; 212 212 - gap: 0.5rem; 207 207 + gap: 1rem; 208 208 + justify-content: center; 213 209 margin: 0; 214 214 - overflow-x: auto; 215 215 - padding: 0.2rem 1.5rem; 216 216 - scroll-padding-inline: 1.5rem; 217 217 - scroll-snap-type: x mandatory; 218 218 - scrollbar-width: none; /* Firefox */ 219 219 - -ms-overflow-style: none; /* IE and Edge */ 210 210 + padding: 0.2rem 0; 220 211 } 221 212 222 213 @media (min-width: 640px) { 223 214 .VPFeatures.VPHomeFeatures > .container > .items { 224 224 - padding: 0.4rem 3rem; 225 225 - scroll-padding-inline: 3rem; 215 215 + gap: 1rem; 216 216 + padding: 0.4rem 0; 226 217 } 227 218 228 219 .home-list > ul, ··· 233 224 234 225 @media (min-width: 960px) { 235 226 .VPFeatures.VPHomeFeatures > .container > .items { 236 236 - padding: 0.5rem 4rem; 237 237 - scroll-padding-inline: 4rem; 227 227 + gap: 1rem; 228 228 + padding: 0.5rem 0; 238 229 } 239 239 - } 240 240 - 241 241 - .VPFeatures.VPHomeFeatures > .container > .items::-webkit-scrollbar { 242 242 - display: none; 243 230 } 244 231 245 232 .VPFeatures.VPHomeFeatures > .container > .items > .item { 246 233 flex-shrink: 0; 247 234 max-width: 390px; 248 235 padding: 0; 249 249 - scroll-snap-align: start; 250 236 width: 100%; 251 237 }

+1 -1

docs/about.md

··· 44 44 45 45 ## Hall of Fame 46 46 47 47 - These are the people with significant contributions to Hey API. A special thank you goes to [Ferdi Koomen](https://madebyferdi.com/) for allowing us to use the original source code from OpenAPI TypeScript Codegen. None of this would've been possible without you! 47 47 + These are the people with significant contributions to Hey API. A special thank you goes to [Ferdi Koomen](https://madebyferdi.com) for allowing us to use the original source code from OpenAPI TypeScript Codegen. None of this would've been possible without you! 48 48 49 49 <VPTeamMembers size="small" :members="hallOfFame" /> 50 50

+1 -1

docs/contributing.md

··· 9 9 10 10 ## Prerequisites 11 11 12 12 - You should have a working knowledge of [git](https://git-scm.com/), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io/). 12 12 + You should have a working knowledge of [git](https://git-scm.com), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io). 13 13 14 14 ## Guidelines 15 15

+14 -23

docs/index.md

··· 25 25 link: /openapi-ts/get-started 26 26 linkText: Get started 27 27 - icon: <svg fill="none" height="24" viewBox="0 0 128 128" width="24" xmlns="http://www.w3.org/2000/svg"><rect fill="#3178c6" height="128" rx="6" width="128"/><path clip-rule="evenodd" d="m74.2622 99.468v14.026c2.2724 1.168 4.9598 2.045 8.0625 2.629 3.1027.585 6.3728.877 9.8105.877 3.3503 0 6.533-.321 9.5478-.964 3.016-.643 5.659-1.702 7.932-3.178 2.272-1.476 4.071-3.404 5.397-5.786 1.325-2.381 1.988-5.325 1.988-8.8313 0-2.5421-.379-4.7701-1.136-6.6841-.758-1.9139-1.85-3.6159-3.278-5.1062-1.427-1.4902-3.139-2.827-5.134-4.0104-1.996-1.1834-4.246-2.3011-6.752-3.353-1.8352-.7597-3.4812-1.4975-4.9378-2.2134-1.4567-.7159-2.6948-1.4464-3.7144-2.1915-1.0197-.7452-1.8063-1.5341-2.3598-2.3669-.5535-.8327-.8303-1.7751-.8303-2.827 0-.9643.2476-1.8336.7429-2.6079s1.1945-1.4391 2.0976-1.9943c.9031-.5551 2.0101-.9861 3.3211-1.2929 1.311-.3069 2.7676-.4603 4.3699-.4603 1.1658 0 2.3958.0877 3.6928.263 1.296.1753 2.6.4456 3.911.8109 1.311.3652 2.585.8254 3.824 1.3806 1.238.5552 2.381 1.198 3.43 1.9285v-13.1051c-2.127-.8182-4.45-1.4245-6.97-1.819s-5.411-.5917-8.6744-.5917c-3.3211 0-6.4674.3579-9.439 1.0738-2.9715.7159-5.5862 1.8336-7.844 3.353-2.2578 1.5195-4.0422 3.4553-5.3531 5.8075-1.311 2.3522-1.9665 5.1646-1.9665 8.4373 0 4.1785 1.2017 7.7433 3.6052 10.6945 2.4035 2.9513 6.0523 5.4496 10.9466 7.495 1.9228.7889 3.7145 1.5633 5.375 2.323 1.6606.7597 3.0954 1.5486 4.3044 2.3668s2.1628 1.7094 2.8618 2.6736c.7.9643 1.049 2.06 1.049 3.2873 0 .9062-.218 1.7462-.655 2.5202s-1.1 1.446-1.9885 2.016c-.8886.57-1.9956 1.016-3.3212 1.337-1.3255.321-2.8768.482-4.6539.482-3.0299 0-6.0305-.533-9.0021-1.6-2.9715-1.066-5.7245-2.666-8.2591-4.799zm-23.5596-34.9136h18.2974v-11.5544h-51v11.5544h18.2079v51.4456h14.4947z" fill="#fff" fill-rule="evenodd"/></svg> 28 28 - title: Type Safety 29 29 - details: Ensure code correctness without runtime overhead. No manual maintenance required. 28 28 + title: Types and SDKs 29 29 + details: Highly customizable output with sensible defaults. No manual maintenance required. 30 30 link: /openapi-ts/output 31 31 - linkText: Learn more 31 31 + linkText: See output 32 32 - icon: <svg class="icon-json-schema xmlns="http://www.w3.org/2000/svg" viewBox="0 0 70.423 70.423" height="24" width="24"><g fill="#fff"><path d="M122.994 114.19c-4.329-.94-7.58-3.479-8.712-6.801-.79-2.316-.677-6.072.333-11.15.485-2.439.882-5.349.882-6.467-.001-3.718-1.712-5.736-5.1-6.017l-1.955-.162v-4.785l1.852-.251c2.702-.366 3.744-1.029 4.576-2.91.611-1.38.689-2.068.505-4.472-.119-1.562-.535-4.349-.924-6.192-.99-4.683-.949-8.485.117-10.773 1.568-3.369 5.437-5.855 9.932-6.383l1.933-.227v5.036h-1.3c-1.771 0-4.25 1.262-4.883 2.488-.608 1.176-.654 2.864-.158 5.802.783 4.644 1.047 9.099.676 11.422-.425 2.658-1.975 5.796-3.68 7.448l-1.18 1.144 1.615 1.983c1.99 2.443 2.765 4.148 3.243 7.142.378 2.369.085 7.283-.67 11.214-1.054 5.485.162 7.652 4.661 8.306l1.676.244v2.448c0 2.792.171 2.697-3.439 1.913z" style="stroke-width:.35277775" transform="translate(-104.228 -45.508)"/><path d="M152.23 112.25v-2.43l2.05-.424c2.263-.467 4.054-1.863 4.459-3.475.127-.507-.113-3.164-.534-5.903-1.372-8.93-.611-13.537 2.855-17.297l1.482-1.608-1.11-1.266c-3.98-4.53-4.67-8.552-3.154-18.37.763-4.945.764-4.993.087-6.173-.797-1.388-3.284-2.776-4.975-2.776h-1.16v-2.47c0-2.81-.058-2.773 3.246-2.072 3.965.841 6.805 2.853 8.278 5.865.846 1.728.973 2.4.95 5.01-.016 1.66-.358 4.683-.762 6.72-1.499 7.564-1.365 9.576.765 11.533.99.908 1.64 1.173 3.37 1.368l2.145.243v4.848h-1.676c-2.151.001-3.932.91-4.838 2.47-.952 1.637-.893 5.206.173 10.406.907 4.422 1.053 8.459.389 10.729-.701 2.394-3.82 5.296-6.748 6.277-1.261.423-2.968.871-3.792.996l-1.5.228z" style="stroke-width:.35277778" transform="translate(-104.228 -45.508)"/><path d="M131.742 108.266c-1.021-1.299-.873-3.537.381-5.732.928-1.624 4.809-6.948 7.61-10.44l1.132-1.41-1.802-5.226c-2.022-5.86-2.01-5.974.656-6.372l1.468-.219 1.64 3.35c.903 1.843 1.77 3.351 1.928 3.351.158 0 1.775-1.755 3.594-3.9 3.16-3.727 3.357-3.892 4.426-3.694.645.12 1.218.047 1.354-.173.318-.515 1.23.247 1.23 1.027 0 .32-.453 1.134-1.009 1.81-2.267 2.755-7.104 9.27-7.104 9.57 0 .177.975 2.454 2.167 5.059l2.166 4.736-.658.985c-.362.541-.662 1.126-.667 1.299-.005.173-.278.483-.606.69-.832.525-1.447-.115-3.99-4.153-1.164-1.848-2.231-3.365-2.372-3.37-.313-.01-3.79 5.133-6.48 9.581-2.37 3.924-1.938 3.42-3.265 3.801-.956.274-1.194.199-1.799-.57zM131.986 83.677c-2.152-3.847-6.019-9.428-7.579-10.938-.792-.767-1.44-1.575-1.44-1.796 0-.601 1.616-1.22 3.19-1.22 1.698 0 3.496 1.479 5.1 4.193.582.985 1.156 1.794 1.276 1.798.12.004.809-1.651 1.53-3.678 1.547-4.34 5.624-12.778 7.225-14.951 1.373-1.863 3.43-2.865 5.903-2.876 3.234-.013 3.243.13.205 3.297-4.636 4.832-6.764 8.81-11.252 21.037-1.246 3.396-2.39 6.48-2.542 6.852-.23.566-.498.281-1.616-1.718z" style="stroke-width:.35277775" transform="translate(-104.228 -45.508)"/></g></svg> 33 33 - title: Data Fetching 34 34 - details: Type-safe data with our REST clients. Fetch, Axios, Nuxt, Angular, and Node are available. 33 33 + title: Clients 34 34 + details: Type-safe data with REST clients for your runtime. Fetch API, Next.js, Nuxt and more. 35 35 link: /openapi-ts/clients 36 36 - linkText: See all clients 36 36 + linkText: Explore clients 37 37 - icon: <svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 190 190"><g fill="none" fill-rule="evenodd"><path d="M150.276 61.344c3.093-14.981 3.756-26.471 1.757-34.815-1.189-4.962-3.362-9.01-6.668-11.93-3.49-3.084-7.901-4.597-12.858-4.597-8.178 0-16.775 3.725-25.963 10.802-3.747 2.887-7.636 6.366-11.676 10.44a8.743 8.743 0 0 0-1.09-1.163C82.36 19.915 72.746 13.599 64.523 11.164c-4.89-1.448-9.48-1.586-13.66-.181-4.414 1.483-7.93 4.55-10.41 8.845-4.094 7.089-5.174 16.403-3.648 27.904.623 4.688 1.686 9.794 3.189 15.327a8.725 8.725 0 0 0-1.698.38c-14.489 4.797-24.749 9.955-30.96 15.85-3.696 3.506-6.109 7.41-6.981 11.733-.921 4.562-.023 9.137 2.454 13.43 4.087 7.078 11.6 12.66 22.304 17.082 4.298 1.776 9.161 3.384 14.595 4.83a8.735 8.735 0 0 0-.57 1.776c-3.092 14.98-3.756 26.47-1.756 34.814 1.188 4.962 3.362 9.01 6.667 11.93 3.49 3.084 7.902 4.597 12.86 4.597 8.177 0 16.774-3.725 25.962-10.802 3.787-2.917 7.72-6.44 11.805-10.57.42.656.936 1.267 1.546 1.81 11.42 10.166 21.034 16.482 29.257 18.917 4.89 1.448 9.48 1.586 13.66.181 4.414-1.483 7.93-4.55 10.41-8.845 4.094-7.089 5.174-16.403 3.648-27.904-.645-4.857-1.764-10.164-3.354-15.929a8.715 8.715 0 0 0 1.863-.398c14.489-4.797 24.749-9.955 30.96-15.85 3.696-3.506 6.109-7.41 6.981-11.733.921-4.562.023-9.137-2.454-13.43-4.087-7.078-11.6-12.66-22.304-17.082-4.427-1.828-9.452-3.48-15.082-4.959.2-.49.36-1.006.47-1.543Z" fill="#002C4B" fill-rule="nonzero"/><path d="M80.397 64h29.211a5 5 0 0 1 4.337 2.512l14.632 25.5a5 5 0 0 1 0 4.976l-14.632 25.5a5 5 0 0 1-4.337 2.512H80.397a5 5 0 0 1-4.337-2.512l-14.632-25.5a5 5 0 0 1 0-4.976l14.632-25.5A5 5 0 0 1 80.397 64Zm25.59 6.277a5 5 0 0 1 4.339 2.513l11.017 19.224a5 5 0 0 1 0 4.972l-11.017 19.224a5 5 0 0 1-4.338 2.513h-21.97a5 5 0 0 1-4.339-2.513L68.662 96.986a5 5 0 0 1 0-4.972L79.679 72.79a5 5 0 0 1 4.338-2.513h21.97Zm-3.906 6.864H87.924a5 5 0 0 0-4.335 2.51l-7.1 12.358a5 5 0 0 0 0 4.982l7.1 12.358a5 5 0 0 0 4.335 2.51h14.157a5 5 0 0 0 4.335-2.51l7.1-12.358a5 5 0 0 0 0-4.982l-7.1-12.358a5 5 0 0 0-4.335-2.51Zm-3.762 6.571a5 5 0 0 1 4.334 2.506l3.33 5.788a5 5 0 0 1 0 4.988l-3.33 5.788a5 5 0 0 1-4.334 2.506h-6.633a5 5 0 0 1-4.334-2.506l-3.33-5.788a5 5 0 0 1 0-4.988l3.33-5.788a5 5 0 0 1 4.334-2.506h6.633Zm-3.315 6.473a4.313 4.313 0 1 0-.003 8.63 4.313 4.313 0 1 0 .003-8.63ZM60 94.5h7.768" fill="#FFD94C"/><path d="M54.86 108.358a2.713 2.713 0 0 1 3.718 1.041l.475.845a269.421 269.421 0 0 0 11.888 19.191c4.867 7.15 10.34 14.39 16.421 21.716a2.776 2.776 0 0 1-.296 3.847l-.612.537c-20.107 17.568-33.176 21.078-39.206 10.527-5.898-10.32-3.764-29.08 6.403-56.28a2.748 2.748 0 0 1 1.21-1.424Zm85.674 20.684a2.708 2.708 0 0 1 3.126 2.152l.153.792c4.97 26.01 1.47 39.014-10.497 39.014-11.706 0-26.607-11.091-44.703-33.273a2.725 2.725 0 0 1-.613-1.745 2.712 2.712 0 0 1 2.73-2.694l.955.007c7.62.041 15.03-.223 22.226-.794 8.498-.673 17.373-1.826 26.623-3.46Zm6.875-55.23c.523-1.41 2.1-2.149 3.546-1.663l.788.266c25.84 8.803 35.66 18.477 29.455 29.022-6.068 10.314-23.714 17.823-52.936 22.527a2.852 2.852 0 0 1-1.88-.345 2.726 2.726 0 0 1-.993-3.772l.5-.837c3.988-6.694 7.592-13.356 10.813-19.986 3.803-7.83 7.372-16.233 10.707-25.212Zm-85.67-7.776a2.852 2.852 0 0 1 1.878.345 2.726 2.726 0 0 1 .994 3.772l-.5.837c-3.988 6.694-7.592 13.356-10.813 19.986-3.803 7.83-7.372 16.233-10.707 25.212-.523 1.41-2.1 2.149-3.546 1.663l-.788-.266c-25.84-8.803-35.66-18.477-29.455-29.022C14.87 78.25 32.516 70.74 61.738 66.036Zm41.807-31.57c20.107-17.57 33.176-21.079 39.206-10.528 5.898 10.32 3.764 29.08-6.403 56.28a2.748 2.748 0 0 1-1.21 1.424 2.713 2.713 0 0 1-3.717-1.041l-.475-.845a269.421 269.421 0 0 0-11.888-19.191c-4.867-7.15-10.34-14.39-16.421-21.716a2.776 2.776 0 0 1 .296-3.847ZM57.684 18c11.706 0 26.607 11.091 44.703 33.273.402.492.618 1.11.613 1.745a2.712 2.712 0 0 1-2.73 2.694l-.955-.007c-7.62-.041-15.03.223-22.226.794-8.498.673-17.373 1.826-26.623 3.46a2.708 2.708 0 0 1-3.126-2.153l-.153-.792C42.217 31.004 45.717 18 57.684 18Z" fill="#FF4154"/></g></svg> 38 38 title: Plugins 39 39 details: Reduce third-party boilerplate with our plugin ecosystem. 40 40 link: /openapi-ts/plugins 41 41 - linkText: Learn more 41 41 + linkText: Explore plugins 42 42 + - icon: 🧩 43 43 + title: Custom 44 44 + details: Build your own plugins and clients for proprietary use cases. 45 45 + link: /openapi-ts/plugins/custom 46 46 + linkText: Build a custom plugin 42 47 - icon: <svg class="icon-github" width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 98 98"><path fill-rule="evenodd" clip-rule="evenodd" d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z" fill="#24292f"/></svg> 43 48 title: Integrations 44 44 - details: Automatically update your code when the APIs it depends on change. Works with any codegen. 49 49 + details: Superpower your codegen with automations and integrations. 45 50 link: /openapi-ts/integrations 46 46 - linkText: Find out more 51 51 + linkText: Learn about integrations 47 52 --- 48 53 49 54 <br /> ··· 53 58 ### Sponsors 54 59 55 60 <!--@include: ./sponsors-list.md--> 56 56 - 57 57 - </div> 58 58 - 59 59 - <br /> 60 60 - 61 61 - <!--@include: ./email-form.md--> 62 62 - 63 63 - <br /> 64 64 - 65 65 - <div class="home-list"> 66 66 - 67 67 - ### Migration Guides 68 68 - 69 69 - - [OpenAPI TypeScript Codegen](/openapi-ts/migrating#openapi-typescript-codegen) 70 61 71 62 </div> 72 63

+1 -1

docs/openapi-ts/clients.md

··· 31 31 - [Nuxt](/openapi-ts/clients/nuxt) 32 32 - [Legacy](/openapi-ts/clients/legacy) 33 33 34 34 - Don't see your client? Let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 34 34 + Don't see your client? [Build your own](/openapi-ts/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 35 35 36 36 <!--@include: ../examples.md--> 37 37 <!--@include: ../sponsors.md-->

+1 -1

docs/openapi-ts/clients/axios.md

··· 15 15 16 16 ### About 17 17 18 18 - [Axios](https://axios-http.com/) is a simple promise based HTTP client for the browser and Node.js. Axios provides a simple to use library in a small package with a very extensible interface. 18 18 + [Axios](https://axios-http.com) is a simple promise based HTTP client for the browser and Node.js. Axios provides a simple to use library in a small package with a very extensible interface. 19 19 20 20 ### Demo 21 21

+3 -3

docs/openapi-ts/clients/legacy.md

··· 61 61 62 62 ## Available Clients 63 63 64 64 - - [angular](https://angular.io/) (using [RxJS](https://rxjs.dev/)) 65 65 - - [axios](https://axios-http.com/) 64 64 + - [angular](https://angular.io) (using [RxJS](https://rxjs.dev)) 65 65 + - [axios](https://axios-http.com) 66 66 - [fetch](https://developer.mozilla.org/docs/Web/API/Fetch_API) 67 67 - - [node](https://nodejs.org/) (using [node-fetch](https://www.npmjs.com/package/node-fetch)) 67 67 + - [node](https://nodejs.org) (using [node-fetch](https://www.npmjs.com/package/node-fetch)) 68 68 - [xhr](https://developer.mozilla.org/docs/Web/API/XMLHttpRequest) 69 69 70 70 ## Caveats

+1 -1

docs/openapi-ts/clients/next-js.md

··· 11 11 12 12 ### About 13 13 14 14 - [Next.js](https://nextjs.org/) is the React framework for the web. Used by some of the world's largest companies, Next.js enables you to create high-quality web applications with the power of React components. 14 14 + [Next.js](https://nextjs.org) is the React framework for the web. Used by some of the world's largest companies, Next.js enables you to create high-quality web applications with the power of React components. 15 15 16 16 <!-- <button class="buttonLink" @click="(event) => embedProject('hey-api-client-next-example')(event)"> 17 17 Launch demo

+5 -1

docs/openapi-ts/clients/nuxt.md

··· 11 11 12 12 ### About 13 13 14 14 - [Nuxt](https://nuxt.com/) is an open source framework that makes web development intuitive and powerful. 14 14 + [Nuxt](https://nuxt.com) is an open source framework that makes web development intuitive and powerful. 15 15 + 16 16 + ::: tip 17 17 + You might be interested in the [Nuxt module](https://www.npmjs.com/package/@hey-api/nuxt) instead. It offers all the features mentioned in this guide in a more familiar way. 18 18 + ::: 15 19 16 20 <!-- <button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-example')(event)"> 17 21 Launch demo

+6 -6

docs/openapi-ts/get-started.md

··· 23 23 24 24 ## Features 25 25 26 26 - - works with CLI, Node.js 18+, or npx 27 27 - - supports OpenAPI 2.0, 3.0, and 3.1 specifications 28 28 - - supports JSON and YAML input files 29 29 - - generates TypeScript interfaces and SDKs 30 30 - - Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available 26 26 + - runs in CLI, Node.js 18+, or npx 27 27 + - works with OpenAPI 2.0, 3.0, and 3.1 28 28 + - customizable types and SDKs 29 29 + - clients for your runtime (Fetch API, Axios, Next.js, Nuxt, etc.) 31 30 - plugin ecosystem to reduce third-party boilerplate 32 32 - - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 31 31 + - custom plugins and custom clients 32 32 + - [integration](/openapi-ts/integrations) with Hey API Platform 33 33 34 34 ## Quick Start 35 35

+2 -2

docs/openapi-ts/integrations.md

··· 24 24 25 25 ### Prerequisites 26 26 27 27 - 1. Create a **free account** with [Hey API](https://app.heyapi.dev/). 27 27 + 1. Create a **free account** with [Hey API](https://app.heyapi.dev). 28 28 1. Create a new **organization** and **project** for your API provider. We recommend your naming matches your GitHub structure as it will be referenced by API clients. For example, we are using **hey-api/backend** for the platform. 29 29 1. Inside your project, go to _Integrations_ > _APIs_ and generate an **API key**. Keep this value secret, it will be used to upload files. 30 30 ··· 78 78 79 79 #### `API_KEY` 80 80 81 81 - This is the project API key you obtained from [Hey API](https://app.heyapi.dev/). 81 81 + This is the project API key you obtained from [Hey API](https://app.heyapi.dev). 82 82 83 83 ::: warning 84 84 Personal API keys can't be used to upload specifications.

+2

docs/openapi-ts/plugins.md

··· 51 51 - [Yup](/openapi-ts/plugins/yup) <span data-soon>Soon</span> 52 52 - [Zustand](/openapi-ts/plugins/zustand) <span data-soon>Soon</span> 53 53 54 54 + Don't see your plugin? [Build your own](/openapi-ts/plugins/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 55 55 + 54 56 ## Community 55 57 56 58 Featured community plugins.

+1 -1

docs/openapi-ts/plugins/ajv.md

··· 11 11 12 12 ### About 13 13 14 14 - [Ajv](https://ajv.js.org/) is the fastest JSON validator for Node.js and browser. 14 14 + [Ajv](https://ajv.js.org) is the fastest JSON validator for Node.js and browser. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/arktype.md

··· 11 11 12 12 ### About 13 13 14 14 - [Arktype](https://arktype.io/) is a TypeScript's 1:1 validator, optimized from editor to runtime. 14 14 + [Arktype](https://arktype.io) is a TypeScript's 1:1 validator, optimized from editor to runtime. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/express.md

··· 11 11 12 12 ### About 13 13 14 14 - [Express](https://expressjs.com/) is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. 14 14 + [Express](https://expressjs.com) is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/faker.md

··· 11 11 12 12 ### About 13 13 14 14 - [Faker](https://fakerjs.dev/) is a popular library that generates fake (but reasonable) data that can be used for things such as unit testing, performance testing, building demos, and working without a completed backend. 14 14 + [Faker](https://fakerjs.dev) is a popular library that generates fake (but reasonable) data that can be used for things such as unit testing, performance testing, building demos, and working without a completed backend. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/fastify.md

··· 11 11 12 12 ### About 13 13 14 14 - [Fastify](https://fastify.dev/) is a fast and low overhead web framework for Node.js. 14 14 + [Fastify](https://fastify.dev) is a fast and low overhead web framework for Node.js. 15 15 16 16 <!-- ### Demo 17 17

+1 -1

docs/openapi-ts/plugins/hono.md

··· 11 11 12 12 ### About 13 13 14 14 - [Hono](https://hono.dev/) is a small, simple, and ultrafast web framework built on Web Standards. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, Netlify, AWS Lambda, Lambda@Edge, and Node.js. 14 14 + [Hono](https://hono.dev) is a small, simple, and ultrafast web framework built on Web Standards. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, Netlify, AWS Lambda, Lambda@Edge, and Node.js. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/joi.md

··· 11 11 12 12 ### About 13 13 14 14 - [Joi](https://joi.dev/) is the most powerful schema description language and data validator for JavaScript. 14 14 + [Joi](https://joi.dev) is the most powerful schema description language and data validator for JavaScript. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/koa.md

··· 11 11 12 12 ### About 13 13 14 14 - [Koa](https://koajs.com/) is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs. 14 14 + [Koa](https://koajs.com) is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/msw.md

··· 11 11 12 12 ### About 13 13 14 14 - [MSW](https://mswjs.io/) is an API mocking library that allows you to write client-agnostic mocks and reuse them across any frameworks, tools, and environments. 14 14 + [MSW](https://mswjs.io) is an API mocking library that allows you to write client-agnostic mocks and reuse them across any frameworks, tools, and environments. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/nest.md

··· 11 11 12 12 ### About 13 13 14 14 - [Nest](https://nestjs.com/) is a progressive Node.js framework for building efficient, reliable and scalable server-side applications. 14 14 + [Nest](https://nestjs.com) is a progressive Node.js framework for building efficient, reliable and scalable server-side applications. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/pinia-colada.md

··· 11 11 12 12 ### About 13 13 14 14 - [Pinia Colada](https://pinia-colada.esm.dev/) is the data fetching layer for Pinia. 14 14 + [Pinia Colada](https://pinia-colada.esm.dev) is the data fetching layer for Pinia. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/superstruct.md

··· 11 11 12 12 ### About 13 13 14 14 - [Superstruct](https://docs.superstructjs.org/) makes it easy to define interfaces and then validate JavaScript data against them. 14 14 + [Superstruct](https://docs.superstructjs.org) makes it easy to define interfaces and then validate JavaScript data against them. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/swr.md

··· 11 11 12 12 ### About 13 13 14 14 - [SWR](https://swr.vercel.app/) is a strategy to first return the data from cache (stale), then send the fetch request (revalidate), and finally come with the up-to-date data. 14 14 + [SWR](https://swr.vercel.app) is a strategy to first return the data from cache (stale), then send the fetch request (revalidate), and finally come with the up-to-date data. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/valibot.md

··· 11 11 12 12 ### About 13 13 14 14 - [Valibot](https://valibot.dev/) is the open source schema library for TypeScript with bundle size, type safety and developer experience in mind. 14 14 + [Valibot](https://valibot.dev) is the open source schema library for TypeScript with bundle size, type safety and developer experience in mind. 15 15 16 16 <!--@include: ../../sponsors.md-->

+1 -1

docs/openapi-ts/plugins/zod.md

··· 11 11 12 12 ### About 13 13 14 14 - [Zod](https://zod.dev/) is a TypeScript-first schema validation library with static type inference. 14 14 + [Zod](https://zod.dev) is a TypeScript-first schema validation library with static type inference. 15 15 16 16 <!-- ### Demo 17 17

+1 -1

docs/openapi-ts/plugins/zustand.md

··· 11 11 12 12 ### About 13 13 14 14 - [Zustand](https://zustand-demo.pmnd.rs/) is a small, fast, and scalable bearbones state management solution. 14 14 + [Zustand](https://zustand-demo.pmnd.rs) is a small, fast, and scalable bearbones state management solution. 15 15 16 16 <!--@include: ../../sponsors.md-->

+4 -4

examples/openapi-ts-tanstack-vue-query/README.md

··· 4 4 5 5 ## Recommended IDE Setup 6 6 7 7 - [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). 7 7 + [VSCode](https://code.visualstudio.com) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). 8 8 9 9 ## Type Support for `.vue` Imports in TS 10 10 ··· 12 12 13 13 ## Customize configuration 14 14 15 15 - See [Vite Configuration Reference](https://vitejs.dev/config/). 15 15 + See [Vite Configuration Reference](https://vitejs.dev/config). 16 16 17 17 ## Project Setup 18 18 ··· 32 32 pnpm build 33 33 ``` 34 34 35 35 - ### Run Unit Tests with [Vitest](https://vitest.dev/) 35 35 + ### Run Unit Tests with [Vitest](https://vitest.dev) 36 36 37 37 ```sh 38 38 pnpm test:unit 39 39 ``` 40 40 41 41 - ### Lint with [ESLint](https://eslint.org/) 41 41 + ### Lint with [ESLint](https://eslint.org) 42 42 43 43 ```sh 44 44 pnpm lint

+5 -3

packages/client-axios/README.md

··· 17 17 - support bundling inside the generated output 18 18 - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 19 19 20 20 - ## Platform 20 20 + ## Dashboard 21 21 22 22 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 22 22 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 23 23 + 24 24 + [Sign In](https://app.heyapi.dev) to Hey API platform. 23 25 24 26 ## Documentation 25 27 26 26 - Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. 28 28 + Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. 27 29 28 30 ## Sponsors 29 31

+5 -3

packages/client-fetch/README.md

··· 17 17 - support bundling inside the generated output 18 18 - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 19 19 20 20 - ## Platform 20 20 + ## Dashboard 21 21 22 22 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 22 22 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 23 23 + 24 24 + [Sign In](https://app.heyapi.dev) to Hey API platform. 23 25 24 26 ## Documentation 25 27 26 26 - Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. 28 28 + Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. 27 29 28 30 ## Sponsors 29 31

+5 -3

packages/client-next/README.md

··· 18 18 - support bundling inside the generated output 19 19 - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 20 20 21 21 - ## Platform 21 21 + ## Dashboard 22 22 23 23 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 23 23 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 24 24 + 25 25 + [Sign In](https://app.heyapi.dev) to Hey API platform. 24 26 25 27 ## Documentation 26 28 27 27 - Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. 29 29 + Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. 28 30 29 31 ## Sponsors 30 32

+5 -3

packages/client-nuxt/README.md

··· 18 18 - support bundling inside the generated output 19 19 - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 20 20 21 21 - ## Platform 21 21 + ## Dashboard 22 22 23 23 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 23 23 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 24 24 + 25 25 + [Sign In](https://app.heyapi.dev) to Hey API platform. 24 26 25 27 ## Documentation 26 28 27 27 - Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. 29 29 + Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. 28 30 29 31 ## Sponsors 30 32

+5 -3

packages/nuxt/README.md

··· 18 18 - support bundling inside the generated output 19 19 - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 20 20 21 21 - ## Platform 21 21 + ## Dashboard 22 22 23 23 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 23 23 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 24 24 + 25 25 + [Sign In](https://app.heyapi.dev) to Hey API platform. 24 26 25 27 ## Documentation 26 28 27 27 - Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. 29 29 + Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. 28 30 29 31 ## Sponsors 30 32

+20 -9

packages/openapi-ts/README.md

··· 30 30 31 31 ## Features 32 32 33 33 - - works with CLI, Node.js 18+, or npx 34 34 - - supports OpenAPI 2.0, 3.0, and 3.1 specifications 35 35 - - supports JSON and YAML input files 36 36 - - generates TypeScript interfaces and SDKs 37 37 - - Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available 33 33 + - runs in CLI, Node.js 18+, or npx 34 34 + - works with OpenAPI 2.0, 3.0, and 3.1 35 35 + - customizable types and SDKs 36 36 + - clients for your runtime (Fetch API, Axios, Next.js, Nuxt, etc.) 38 37 - plugin ecosystem to reduce third-party boilerplate 39 39 - - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds 38 38 + - custom plugins and custom clients 39 39 + - [integration](https://heyapi.dev/openapi-ts/integrations) with Hey API platform 40 40 + 41 41 + ## Dashboard 40 42 41 41 - ## Platform 43 43 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 42 44 43 43 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 45 45 + [Sign In](https://app.heyapi.dev) to Hey API platform. 44 46 45 47 ## Sponsors 46 48 ··· 177 179 178 180 Clients are responsible for sending the actual HTTP requests. Using clients is not required, but you must add a client to `plugins` if you're generating SDKs (enabled by default). 179 181 180 180 - You can learn more on the [Clients](https://heyapi.dev/openapi-ts/clients) page. 182 182 + ### Native Clients 183 183 + 184 184 + - [`@hey-api/client-fetch](https://heyapi.dev/openapi-ts/clients/fetch) 185 185 + - [`@hey-api/client-axios](https://heyapi.dev/openapi-ts/clients/axios) 186 186 + - [`@hey-api/client-next](https://heyapi.dev/openapi-ts/clients/next-js) 187 187 + - [`@hey-api/client-nuxt](https://heyapi.dev/openapi-ts/clients/nuxt) 188 188 + 189 189 + Don't see your client? [Build your own](https://heyapi.dev/openapi-ts/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 181 190 182 191 ## Plugins 183 192 ··· 221 230 - [Valibot](https://heyapi.dev/openapi-ts/plugins/valibot) 222 231 - [Yup](https://heyapi.dev/openapi-ts/plugins/yup) 223 232 - [Zustand](https://heyapi.dev/openapi-ts/plugins/zustand) 233 233 + 234 234 + Don't see your plugin? [Build your own](https://heyapi.dev/openapi-ts/plugins/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). 224 235 225 236 ## Migration Guides 226 237

+5 -3

packages/vite-plugin/README.md

··· 4 4 <p align="center">🚀 Vite plugin for `@hey-api/openapi-ts` codegen.</p> 5 5 </div> 6 6 7 7 - ## Platform 7 7 + ## Dashboard 8 8 9 9 - Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations). 9 9 + Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. 10 10 + 11 11 + [Sign In](https://app.heyapi.dev) to Hey API platform. 10 12 11 13 ## Documentation 12 14 13 13 - Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. 15 15 + Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. 14 16 15 17 ## Sponsors 16 18