René's URL Explorer Experiment


Title: Get Started | Hey API

Open Graph Title: Get Started

Description: Get started with @hey-api/openapi-ts.

Open Graph Description: Get started with @hey-api/openapi-ts.

Opengraph URL: https://heyapi.dev/docs/openapi/typescript/get-started

Generator: Starlight v0.41.3

direct link

Domain: heyapi.dev

og:typewebsite
og:localeen
og:site_nameHey API
twitter:cardsummary_large_image
og:image/_astro/openapi-ts-hero-640w.B3DAa9V9.png

Links:

Skip to contenthttps://heyapi.dev/docs#_top
llms.txthttps://heyapi.dev/llms.txt
Host your specs. Generate from anywhere.Get Started https://app.heyapi.dev
Hey APIhttps://heyapi.dev/
9% fundedFund your stackhttps://heyapi.dev/sponsors
Get Startedhttps://heyapi.dev/docs/openapi/typescript/get-started
Overviewhttps://heyapi.dev/docs/openapi/typescript/configuration
Inputhttps://heyapi.dev/docs/openapi/typescript/configuration/input
Outputhttps://heyapi.dev/docs/openapi/typescript/configuration/output
Parserhttps://heyapi.dev/docs/openapi/typescript/configuration/parser
Vitehttps://heyapi.dev/docs/openapi/typescript/configuration/vite
Outputhttps://heyapi.dev/docs/openapi/typescript/output
Overviewhttps://heyapi.dev/docs/openapi/typescript/core
TypeScripthttps://heyapi.dev/docs/openapi/typescript/plugins/typescript
SDKhttps://heyapi.dev/docs/openapi/typescript/plugins/sdk
Transformershttps://heyapi.dev/docs/openapi/typescript/plugins/transformers
Schemashttps://heyapi.dev/docs/openapi/typescript/plugins/schemas
Overviewhttps://heyapi.dev/docs/openapi/typescript/clients
Fetch APIhttps://heyapi.dev/docs/openapi/typescript/clients/fetch
Angularhttps://heyapi.dev/docs/openapi/typescript/clients/angular
Axioshttps://heyapi.dev/docs/openapi/typescript/clients/axios
Kyhttps://heyapi.dev/docs/openapi/typescript/clients/ky
Next.jshttps://heyapi.dev/docs/openapi/typescript/clients/next-js
Nuxthttps://heyapi.dev/docs/openapi/typescript/clients/nuxt
OFetchhttps://heyapi.dev/docs/openapi/typescript/clients/ofetch
EffectVotehttps://heyapi.dev/docs/openapi/typescript/clients/effect
GotVotehttps://heyapi.dev/docs/openapi/typescript/clients/got
Overviewhttps://heyapi.dev/docs/openapi/typescript/validators
Valibothttps://heyapi.dev/docs/openapi/typescript/plugins/valibot
Zodhttps://heyapi.dev/docs/openapi/typescript/plugins/zod
AjvVotehttps://heyapi.dev/docs/openapi/typescript/plugins/ajv
ArktypeVotehttps://heyapi.dev/docs/openapi/typescript/plugins/arktype
JoiVotehttps://heyapi.dev/docs/openapi/typescript/plugins/joi
SuperstructVotehttps://heyapi.dev/docs/openapi/typescript/plugins/superstruct
TypeBoxVotehttps://heyapi.dev/docs/openapi/typescript/plugins/typebox
YupVotehttps://heyapi.dev/docs/openapi/typescript/plugins/yup
Overviewhttps://heyapi.dev/docs/openapi/typescript/state-management
Pinia Coladahttps://heyapi.dev/docs/openapi/typescript/plugins/pinia-colada
TanStack Queryhttps://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query
SWRVotehttps://heyapi.dev/docs/openapi/typescript/plugins/swr
ZustandVotehttps://heyapi.dev/docs/openapi/typescript/plugins/zustand
Overviewhttps://heyapi.dev/docs/openapi/typescript/mocks
ChanceVotehttps://heyapi.dev/docs/openapi/typescript/plugins/chance
FakerVotehttps://heyapi.dev/docs/openapi/typescript/plugins/faker
FalsoVotehttps://heyapi.dev/docs/openapi/typescript/plugins/falso
MSWVotehttps://heyapi.dev/docs/openapi/typescript/plugins/msw
NockVotehttps://heyapi.dev/docs/openapi/typescript/plugins/nock
SupertestVotehttps://heyapi.dev/docs/openapi/typescript/plugins/supertest
Overviewhttps://heyapi.dev/docs/openapi/typescript/web-frameworks
Angularhttps://heyapi.dev/docs/openapi/typescript/plugins/angular
Fastifyhttps://heyapi.dev/docs/openapi/typescript/plugins/fastify
Nesthttps://heyapi.dev/docs/openapi/typescript/plugins/nest
oRPChttps://heyapi.dev/docs/openapi/typescript/plugins/orpc
AdonisVotehttps://heyapi.dev/docs/openapi/typescript/plugins/adonis
ElysiaVotehttps://heyapi.dev/docs/openapi/typescript/plugins/elysia
ExpressVotehttps://heyapi.dev/docs/openapi/typescript/plugins/express
HonoVotehttps://heyapi.dev/docs/openapi/typescript/plugins/hono
KoaVotehttps://heyapi.dev/docs/openapi/typescript/plugins/koa
TanStack StartVotehttps://heyapi.dev/docs/openapi/typescript/plugins/tanstack-start
Resolvershttps://heyapi.dev/docs/openapi/typescript/plugins/concepts/resolvers
Pluginhttps://heyapi.dev/docs/openapi/typescript/plugins/custom
Clienthttps://heyapi.dev/docs/openapi/typescript/clients/custom
Spotlighthttps://heyapi.dev/docs/openapi/typescript/community/spotlight
Overviewhttps://heyapi.dev/docs/openapi/typescript/community/contributing
Buildinghttps://heyapi.dev/docs/openapi/typescript/community/contributing/building
Developinghttps://heyapi.dev/docs/openapi/typescript/community/contributing/developing
Testinghttps://heyapi.dev/docs/openapi/typescript/community/contributing/testing
GitHubhttps://heyapi.dev/docs/openapi/typescript/integrations
Migratinghttps://heyapi.dev/docs/openapi/typescript/migrating
Licensehttps://heyapi.dev/docs/openapi/typescript/license
Roadmaphttps://github.com/orgs/hey-api/discussions/3159
Get Startedhttps://heyapi.dev/docs/openapi/typescript/get-started
Overviewhttps://heyapi.dev/docs/openapi/typescript/configuration
Inputhttps://heyapi.dev/docs/openapi/typescript/configuration/input
Outputhttps://heyapi.dev/docs/openapi/typescript/configuration/output
Parserhttps://heyapi.dev/docs/openapi/typescript/configuration/parser
Vitehttps://heyapi.dev/docs/openapi/typescript/configuration/vite
Outputhttps://heyapi.dev/docs/openapi/typescript/output
Overviewhttps://heyapi.dev/docs/openapi/typescript/core
TypeScripthttps://heyapi.dev/docs/openapi/typescript/plugins/typescript
SDKhttps://heyapi.dev/docs/openapi/typescript/plugins/sdk
Transformershttps://heyapi.dev/docs/openapi/typescript/plugins/transformers
Schemashttps://heyapi.dev/docs/openapi/typescript/plugins/schemas
Overviewhttps://heyapi.dev/docs/openapi/typescript/clients
Fetch APIhttps://heyapi.dev/docs/openapi/typescript/clients/fetch
Angularhttps://heyapi.dev/docs/openapi/typescript/clients/angular
Axioshttps://heyapi.dev/docs/openapi/typescript/clients/axios
Kyhttps://heyapi.dev/docs/openapi/typescript/clients/ky
Next.jshttps://heyapi.dev/docs/openapi/typescript/clients/next-js
Nuxthttps://heyapi.dev/docs/openapi/typescript/clients/nuxt
OFetchhttps://heyapi.dev/docs/openapi/typescript/clients/ofetch
EffectVotehttps://heyapi.dev/docs/openapi/typescript/clients/effect
GotVotehttps://heyapi.dev/docs/openapi/typescript/clients/got
Overviewhttps://heyapi.dev/docs/openapi/typescript/validators
Valibothttps://heyapi.dev/docs/openapi/typescript/plugins/valibot
Zodhttps://heyapi.dev/docs/openapi/typescript/plugins/zod
AjvVotehttps://heyapi.dev/docs/openapi/typescript/plugins/ajv
ArktypeVotehttps://heyapi.dev/docs/openapi/typescript/plugins/arktype
JoiVotehttps://heyapi.dev/docs/openapi/typescript/plugins/joi
SuperstructVotehttps://heyapi.dev/docs/openapi/typescript/plugins/superstruct
TypeBoxVotehttps://heyapi.dev/docs/openapi/typescript/plugins/typebox
YupVotehttps://heyapi.dev/docs/openapi/typescript/plugins/yup
Overviewhttps://heyapi.dev/docs/openapi/typescript/state-management
Pinia Coladahttps://heyapi.dev/docs/openapi/typescript/plugins/pinia-colada
TanStack Queryhttps://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query
SWRVotehttps://heyapi.dev/docs/openapi/typescript/plugins/swr
ZustandVotehttps://heyapi.dev/docs/openapi/typescript/plugins/zustand
Overviewhttps://heyapi.dev/docs/openapi/typescript/mocks
ChanceVotehttps://heyapi.dev/docs/openapi/typescript/plugins/chance
FakerVotehttps://heyapi.dev/docs/openapi/typescript/plugins/faker
FalsoVotehttps://heyapi.dev/docs/openapi/typescript/plugins/falso
MSWVotehttps://heyapi.dev/docs/openapi/typescript/plugins/msw
NockVotehttps://heyapi.dev/docs/openapi/typescript/plugins/nock
SupertestVotehttps://heyapi.dev/docs/openapi/typescript/plugins/supertest
Overviewhttps://heyapi.dev/docs/openapi/typescript/web-frameworks
Angularhttps://heyapi.dev/docs/openapi/typescript/plugins/angular
Fastifyhttps://heyapi.dev/docs/openapi/typescript/plugins/fastify
Nesthttps://heyapi.dev/docs/openapi/typescript/plugins/nest
oRPChttps://heyapi.dev/docs/openapi/typescript/plugins/orpc
AdonisVotehttps://heyapi.dev/docs/openapi/typescript/plugins/adonis
ElysiaVotehttps://heyapi.dev/docs/openapi/typescript/plugins/elysia
ExpressVotehttps://heyapi.dev/docs/openapi/typescript/plugins/express
HonoVotehttps://heyapi.dev/docs/openapi/typescript/plugins/hono
KoaVotehttps://heyapi.dev/docs/openapi/typescript/plugins/koa
TanStack StartVotehttps://heyapi.dev/docs/openapi/typescript/plugins/tanstack-start
Resolvershttps://heyapi.dev/docs/openapi/typescript/plugins/concepts/resolvers
Pluginhttps://heyapi.dev/docs/openapi/typescript/plugins/custom
Clienthttps://heyapi.dev/docs/openapi/typescript/clients/custom
Spotlighthttps://heyapi.dev/docs/openapi/typescript/community/spotlight
Overviewhttps://heyapi.dev/docs/openapi/typescript/community/contributing
Buildinghttps://heyapi.dev/docs/openapi/typescript/community/contributing/building
Developinghttps://heyapi.dev/docs/openapi/typescript/community/contributing/developing
Testinghttps://heyapi.dev/docs/openapi/typescript/community/contributing/testing
GitHubhttps://heyapi.dev/docs/openapi/typescript/integrations
Migratinghttps://heyapi.dev/docs/openapi/typescript/migrating
Licensehttps://heyapi.dev/docs/openapi/typescript/license
Roadmaphttps://github.com/orgs/hey-api/discussions/3159
Get Startedhttps://heyapi.dev/docs#_top
Featureshttps://heyapi.dev/docs#features
Quick Starthttps://heyapi.dev/docs#quick-start
Installationhttps://heyapi.dev/docs#installation
Usagehttps://heyapi.dev/docs#usage
Copy as Markdownhttps://heyapi.dev/docs
Open in Claudehttps://heyapi.dev/docs
Open in ChatGPThttps://heyapi.dev/docs
Get Startedhttps://heyapi.dev/docs#_top
Featureshttps://heyapi.dev/docs#features
Quick Starthttps://heyapi.dev/docs#quick-start
Installationhttps://heyapi.dev/docs#installation
Usagehttps://heyapi.dev/docs#usage
Copy as Markdownhttps://heyapi.dev/docs
Open in Claudehttps://heyapi.dev/docs
Open in ChatGPThttps://heyapi.dev/docs
@hey-api/openapi-tshttps://github.com/hey-api/hey-api
Section titled “Demo”https://heyapi.dev/docs#demo
Section titled “Features”https://heyapi.dev/docs#features
sync with Hey API Registryhttps://heyapi.dev/docs/openapi/typescript/integrations
Section titled “Quick Start”https://heyapi.dev/docs#quick-start
Outputhttps://heyapi.dev/docs/openapi/typescript/output
Section titled “Installation”https://heyapi.dev/docs#installation
npmhttps://heyapi.dev/docs#tab-panel-1506
pnpmhttps://heyapi.dev/docs#tab-panel-1507
yarnhttps://heyapi.dev/docs#tab-panel-1508
bunhttps://heyapi.dev/docs#tab-panel-1509
Section titled “Versioning”https://heyapi.dev/docs#versioning
initial developmenthttps://semver.org/#spec-item-4
migration noteshttps://heyapi.dev/docs/openapi/typescript/migrating
Section titled “Usage”https://heyapi.dev/docs#usage
Section titled “CLI”https://heyapi.dev/docs#cli
configurationhttps://heyapi.dev/docs/openapi/typescript/configuration
Section titled “Node.js”https://heyapi.dev/docs#nodejs
Section titled “Vite”https://heyapi.dev/docs#vite
Vitehttps://vite.dev
npmhttps://heyapi.dev/docs#tab-panel-1510
pnpmhttps://heyapi.dev/docs#tab-panel-1511
yarnhttps://heyapi.dev/docs#tab-panel-1512
bunhttps://heyapi.dev/docs#tab-panel-1513
Vitehttps://heyapi.dev/docs/openapi/typescript/configuration/vite
Section titled “Configuration”https://heyapi.dev/docs#configuration
Configurationhttps://heyapi.dev/docs/openapi/typescript/configuration
StackBlitzhttps://stackblitz.com/orgs/github/hey-api/collections/openapi-ts-examples
GitHubhttps://github.com/hey-api/hey-api/tree/main/examples
https://kutt.to/QM9Q2N
https://kutt.to/skQUVd
https://kutt.to/Dr9GuW
https://kutt.to/yZVkdV
Become a sponsor https://heyapi.dev/sponsors
Edit pagehttps://github.com/hey-api/hey-api/edit/main/docs/src/content/docs/docs/openapi/typescript/get-started.mdx
NextConfigurationhttps://heyapi.dev/docs/openapi/typescript/configuration
Star us on GitHubhey-api/hey-apihttps://github.com/hey-api/hey-api
Follow on LinkedInheyapihttps://linkedin.com/company/heyapi
Follow on Bluesky@heyapi.devhttps://bsky.app/profile/heyapi.dev
Follow on X@mrluboshttps://x.com/mrlubos

Viewport: width=device-width, initial-scale=1

URLs of crawlers that visited me.