diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -30,17 +30,19 @@ ## Features -- works with CLI, Node.js 18+, or npx -- supports OpenAPI 2.0, 3.0, and 3.1 specifications -- supports JSON and YAML input files -- generates TypeScript interfaces and SDKs -- Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available +- runs in CLI, Node.js 18+, or npx +- works with OpenAPI 2.0, 3.0, and 3.1 +- customizable types and SDKs +- clients for your runtime (Fetch API, Axios, Next.js, Nuxt, etc.) - plugin ecosystem to reduce third-party boilerplate -- [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds +- custom plugins and custom clients +- [integration](https://heyapi.dev/openapi-ts/integrations) with Hey API platform -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Sponsors @@ -177,7 +179,14 @@ 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). -You can learn more on the [Clients](https://heyapi.dev/openapi-ts/clients) page. +### Native Clients + +- [`@hey-api/client-fetch](https://heyapi.dev/openapi-ts/clients/fetch) +- [`@hey-api/client-axios](https://heyapi.dev/openapi-ts/clients/axios) +- [`@hey-api/client-next](https://heyapi.dev/openapi-ts/clients/next-js) +- [`@hey-api/client-nuxt](https://heyapi.dev/openapi-ts/clients/nuxt) + +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). ## Plugins @@ -221,6 +230,8 @@ - [Valibot](https://heyapi.dev/openapi-ts/plugins/valibot) - [Yup](https://heyapi.dev/openapi-ts/plugins/yup) - [Zustand](https://heyapi.dev/openapi-ts/plugins/zustand) + +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). ## Migration Guides diff --git a/docs/about.md b/docs/about.md --- a/docs/about.md +++ b/docs/about.md @@ -44,7 +44,7 @@ ## Hall of Fame -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! +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! diff --git a/docs/contributing.md b/docs/contributing.md --- a/docs/contributing.md +++ b/docs/contributing.md @@ -9,7 +9,7 @@ ## Prerequisites -You should have a working knowledge of [git](https://git-scm.com/), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io/). +You should have a working knowledge of [git](https://git-scm.com), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io). ## Guidelines diff --git a/docs/index.md b/docs/index.md --- a/docs/index.md +++ b/docs/index.md @@ -25,25 +25,30 @@ link: /openapi-ts/get-started linkText: Get started - icon: - title: Type Safety - details: Ensure code correctness without runtime overhead. No manual maintenance required. + title: Types and SDKs + details: Highly customizable output with sensible defaults. No manual maintenance required. link: /openapi-ts/output - linkText: Learn more + linkText: See output - icon: - title: Data Fetching - details: Type-safe data with our REST clients. Fetch, Axios, Nuxt, Angular, and Node are available. + title: Clients + details: Type-safe data with REST clients for your runtime. Fetch API, Next.js, Nuxt and more. link: /openapi-ts/clients - linkText: See all clients + linkText: Explore clients - icon: title: Plugins details: Reduce third-party boilerplate with our plugin ecosystem. link: /openapi-ts/plugins - linkText: Learn more + linkText: Explore plugins + - icon: 🧩 + title: Custom + details: Build your own plugins and clients for proprietary use cases. + link: /openapi-ts/plugins/custom + linkText: Build a custom plugin - icon: title: Integrations - details: Automatically update your code when the APIs it depends on change. Works with any codegen. + details: Superpower your codegen with automations and integrations. link: /openapi-ts/integrations - linkText: Find out more + linkText: Learn about integrations ---
@@ -53,20 +58,6 @@ ### Sponsors - - - -
- - - -
- -
- -### Migration Guides - -- [OpenAPI TypeScript Codegen](/openapi-ts/migrating#openapi-typescript-codegen)
diff --git a/docs/openapi-ts/clients.md b/docs/openapi-ts/clients.md --- a/docs/openapi-ts/clients.md +++ b/docs/openapi-ts/clients.md @@ -31,7 +31,7 @@ - [Nuxt](/openapi-ts/clients/nuxt) - [Legacy](/openapi-ts/clients/legacy) -Don't see your client? Let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues). +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). diff --git a/docs/openapi-ts/get-started.md b/docs/openapi-ts/get-started.md --- a/docs/openapi-ts/get-started.md +++ b/docs/openapi-ts/get-started.md @@ -23,13 +23,13 @@ ## Features -- works with CLI, Node.js 18+, or npx -- supports OpenAPI 2.0, 3.0, and 3.1 specifications -- supports JSON and YAML input files -- generates TypeScript interfaces and SDKs -- Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available +- runs in CLI, Node.js 18+, or npx +- works with OpenAPI 2.0, 3.0, and 3.1 +- customizable types and SDKs +- clients for your runtime (Fetch API, Axios, Next.js, Nuxt, etc.) - plugin ecosystem to reduce third-party boilerplate -- [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds +- custom plugins and custom clients +- [integration](/openapi-ts/integrations) with Hey API Platform ## Quick Start diff --git a/docs/openapi-ts/integrations.md b/docs/openapi-ts/integrations.md --- a/docs/openapi-ts/integrations.md +++ b/docs/openapi-ts/integrations.md @@ -24,7 +24,7 @@ ### Prerequisites -1. Create a **free account** with [Hey API](https://app.heyapi.dev/). +1. Create a **free account** with [Hey API](https://app.heyapi.dev). 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. 1. Inside your project, go to _Integrations_ > _APIs_ and generate an **API key**. Keep this value secret, it will be used to upload files. @@ -78,7 +78,7 @@ #### `API_KEY` -This is the project API key you obtained from [Hey API](https://app.heyapi.dev/). +This is the project API key you obtained from [Hey API](https://app.heyapi.dev). ::: warning Personal API keys can't be used to upload specifications. diff --git a/docs/openapi-ts/plugins.md b/docs/openapi-ts/plugins.md --- a/docs/openapi-ts/plugins.md +++ b/docs/openapi-ts/plugins.md @@ -51,6 +51,8 @@ - [Yup](/openapi-ts/plugins/yup) Soon - [Zustand](/openapi-ts/plugins/zustand) Soon +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). + ## Community Featured community plugins. diff --git a/examples/openapi-ts-tanstack-vue-query/README.md b/examples/openapi-ts-tanstack-vue-query/README.md --- a/examples/openapi-ts-tanstack-vue-query/README.md +++ b/examples/openapi-ts-tanstack-vue-query/README.md @@ -4,7 +4,7 @@ ## Recommended IDE Setup -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). +[VSCode](https://code.visualstudio.com) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). ## Type Support for `.vue` Imports in TS @@ -12,7 +12,7 @@ ## Customize configuration -See [Vite Configuration Reference](https://vitejs.dev/config/). +See [Vite Configuration Reference](https://vitejs.dev/config). ## Project Setup @@ -32,13 +32,13 @@ pnpm build ``` -### Run Unit Tests with [Vitest](https://vitest.dev/) +### Run Unit Tests with [Vitest](https://vitest.dev) ```sh pnpm test:unit ``` -### Lint with [ESLint](https://eslint.org/) +### Lint with [ESLint](https://eslint.org) ```sh pnpm lint diff --git a/packages/client-axios/README.md b/packages/client-axios/README.md --- a/packages/client-axios/README.md +++ b/packages/client-axios/README.md @@ -17,13 +17,15 @@ - support bundling inside the generated output - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Documentation -Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. ## Sponsors diff --git a/packages/client-fetch/README.md b/packages/client-fetch/README.md --- a/packages/client-fetch/README.md +++ b/packages/client-fetch/README.md @@ -17,13 +17,15 @@ - support bundling inside the generated output - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Documentation -Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. ## Sponsors diff --git a/packages/client-next/README.md b/packages/client-next/README.md --- a/packages/client-next/README.md +++ b/packages/client-next/README.md @@ -18,13 +18,15 @@ - support bundling inside the generated output - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Documentation -Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. ## Sponsors diff --git a/packages/client-nuxt/README.md b/packages/client-nuxt/README.md --- a/packages/client-nuxt/README.md +++ b/packages/client-nuxt/README.md @@ -18,13 +18,15 @@ - support bundling inside the generated output - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Documentation -Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. ## Sponsors diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md --- a/packages/nuxt/README.md +++ b/packages/nuxt/README.md @@ -18,13 +18,15 @@ - support bundling inside the generated output - [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Documentation -Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. ## Sponsors diff --git a/packages/openapi-ts/README.md b/packages/openapi-ts/README.md --- a/packages/openapi-ts/README.md +++ b/packages/openapi-ts/README.md @@ -30,17 +30,19 @@ ## Features -- works with CLI, Node.js 18+, or npx -- supports OpenAPI 2.0, 3.0, and 3.1 specifications -- supports JSON and YAML input files -- generates TypeScript interfaces and SDKs -- Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available +- runs in CLI, Node.js 18+, or npx +- works with OpenAPI 2.0, 3.0, and 3.1 +- customizable types and SDKs +- clients for your runtime (Fetch API, Axios, Next.js, Nuxt, etc.) - plugin ecosystem to reduce third-party boilerplate -- [platform](https://heyapi.dev/openapi-ts/integrations) for automating codegen builds +- custom plugins and custom clients +- [integration](https://heyapi.dev/openapi-ts/integrations) with Hey API platform -## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Sponsors @@ -177,7 +179,14 @@ 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). -You can learn more on the [Clients](https://heyapi.dev/openapi-ts/clients) page. +### Native Clients + +- [`@hey-api/client-fetch](https://heyapi.dev/openapi-ts/clients/fetch) +- [`@hey-api/client-axios](https://heyapi.dev/openapi-ts/clients/axios) +- [`@hey-api/client-next](https://heyapi.dev/openapi-ts/clients/next-js) +- [`@hey-api/client-nuxt](https://heyapi.dev/openapi-ts/clients/nuxt) + +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). ## Plugins @@ -221,6 +230,8 @@ - [Valibot](https://heyapi.dev/openapi-ts/plugins/valibot) - [Yup](https://heyapi.dev/openapi-ts/plugins/yup) - [Zustand](https://heyapi.dev/openapi-ts/plugins/zustand) + +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). ## Migration Guides diff --git a/packages/vite-plugin/README.md b/packages/vite-plugin/README.md --- a/packages/vite-plugin/README.md +++ b/packages/vite-plugin/README.md @@ -4,13 +4,15 @@

🚀 Vite plugin for `@hey-api/openapi-ts` codegen.

-## Platform +## Dashboard -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). +Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with our platform. + +[Sign In](https://app.heyapi.dev) to Hey API platform. ## Documentation -Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev) for documentation, guides, migrating, and more. ## Sponsors diff --git a/docs/.vitepress/theme/Layout.vue b/docs/.vitepress/theme/Layout.vue --- a/docs/.vitepress/theme/Layout.vue +++ b/docs/.vitepress/theme/Layout.vue @@ -8,11 +8,13 @@