{"id":21190135,"url":"https://github.com/greeeg/openapi-kit","last_synced_at":"2025-07-10T02:32:26.629Z","repository":{"id":213416345,"uuid":"733369149","full_name":"greeeg/openapi-kit","owner":"greeeg","description":"A set of utilities to generate an API client, types, mocks \u0026 react-query hooks for OpenAPI","archived":false,"fork":false,"pushed_at":"2024-06-21T06:41:10.000Z","size":1311,"stargazers_count":5,"open_issues_count":7,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-14T13:45:35.452Z","etag":null,"topics":["openapi","swagger","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greeeg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-19T07:08:30.000Z","updated_at":"2024-06-04T21:11:40.000Z","dependencies_parsed_at":"2024-01-16T15:21:08.380Z","dependency_job_id":"90621683-3a02-4a3f-8ee5-571f3cebcfca","html_url":"https://github.com/greeeg/openapi-kit","commit_stats":null,"previous_names":["greeeg/openapi-kit"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greeeg%2Fopenapi-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greeeg%2Fopenapi-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greeeg%2Fopenapi-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greeeg%2Fopenapi-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greeeg","download_url":"https://codeload.github.com/greeeg/openapi-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225615226,"owners_count":17496942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","swagger","typescript"],"created_at":"2024-11-20T18:59:31.304Z","updated_at":"2024-11-20T18:59:32.168Z","avatar_url":"https://github.com/greeeg.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI kit\n\n[![npm version](https://img.shields.io/npm/v/openapi-kit.svg)](https://www.npmjs.com/package/openapi-kit)\n[![npm downloads](https://img.shields.io/npm/dw/openapi-kit.svg)](https://www.npmjs.com/package/openapi-kit)\n[![bundle size](https://img.shields.io/bundlephobia/minzip/openapi-kit.svg?label=gzip%20bundle)](https://bundlephobia.com/package/openapi-kit)\n\n\u003e A set of utilities to generate an API client, types, mocks \u0026 react-query hooks for OpenAPI\n\n## Features\n\n- Parse OpenAPI 3 \u0026 OpenAPI 3.1 YML/JSON documents\n- Generate Typescript types for OpenAPI components \u0026 paths\n- Generate a typed API client with named methods for OpenAPI operations\n- Generate mock data for OpenAPI operations\n- Generate [`react-query`](https://github.com/TanStack/query) query \u0026 mutation hooks for OpenAPI operations\n\n## Getting started\n\nOpenAPI kit comes with a command you can execute to get quickly started.\n\nIf the command does not provide enough options for your generation needs, check out the **\"Advanced usage\"** section to create your own script.\n\n```sh\nyarn add -D openapi-kit\n\n# Used by API client\nyarn add query-string\n\n# Used by `react-query` hooks\nyarn add @tanstack/react-query\n```\n\n```json\n{\n  \"name\": \"my-app\",\n  \"scripts\": {\n    \"openapi\": \"openapi-kit generate -f ./openapi/pet-store.yml -o ./generated\"\n  }\n}\n```\n\n## CLI options\n\n```sh\n# Specify the OpenAPI spec file path \u0026 output directory\nopenapi-kit generate -f ./openapi/pet-store.yml -o ./generated\n\n# The `prettyOutput` flag ensures the output is formatted using Prettier\nopenapi-kit generate -f ./openapi/pet-store.yml -o ./generated --prettyOutput\n\n# Only generate type definitions\nopenapi-kit generate -f ./openapi/pet-store.yml -o ./generated --types\n\n# Only generate type definitions \u0026 API client\nopenapi-kit generate -f ./openapi/pet-store.yml -o ./generated --types --apiClient\n\n# Only generate type definitions \u0026 mock data\nopenapi-kit generate -f ./openapi/pet-store.yml -o ./generated --types --mockData\n```\n\n### Using types\n\n```ts\nimport { Components, Paths } from 'generated/typeDefinitions'\n\ntype Pet = Components.Schemas.Pet\n\nconst pet: Pet = {\n  id: 1,\n  name: 'Paul',\n  tag: 'happy',\n}\n\nconst getPetNames = (response: Paths.ListPets.Responses.$200): string[] =\u003e {\n  return response.map((pet) =\u003e pet.name)\n}\n```\n\n### Using API client\n\n```ts\nimport { getAPIClient } from 'generated/apiClient'\n\nconst apiClient = getAPIClient({\n  baseUrl: 'https://petstore.swagger.io/v2',\n  headers: {\n    Accept: 'application/json',\n  },\n  onError: (error: unknown) =\u003e {\n    if (error instanceof HTTPRequestError \u0026\u0026 error.statusCode === 401) {\n      // Do something\n    }\n  },\n})\n\nconst response = await apiClient.showPetById({\n  pathParams: {\n    petId: 1,\n  },\n})\n\nif (response.ok) {\n  console.log(response.data.name)\n}\n```\n\n### Using mock data\n\n```tsx\nimport PetsList from 'components/PetsList'\nimport { ListPetsResponse$200 } from 'generated/mockData'\n\nconst App = () =\u003e {\n  return \u003cPetsList data={ListPetsResponse$200} /\u003e\n}\n```\n\n### Using `react-query` hooks\n\nFirst, update your React App to include two React context providers:\n\n- One for `react-query`\n- One for your API client\n\n```tsx\nimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'\nimport { APIClientProvider } from 'generated/reactQuery'\n\nconst queryClient = new QueryClient()\n\nconst App = () =\u003e {\n  return (\n    \u003cAPIClientProvider\n      config={{\n        baseUrl: 'https://petstore.swagger.io/v2',\n        headers: {\n          Accept: 'application/json',\n        },\n      }}\n    \u003e\n      \u003cQueryClientProvider client={queryClient}\u003e\n        \u003cMyComponent /\u003e\n      \u003c/QueryClientProvider\u003e\n    \u003c/APIClientProvider\u003e\n  )\n}\n```\n\nThen, use autogenerated queries \u0026 mutations in your app pages \u0026 components.\n\n```tsx\nimport { useListPets } from 'generated/reactQuery'\n\nconst PetsList = () =\u003e {\n  const { data, isLoading } = useListPets({\n    pathParams: {\n      owner: 'John',\n    },\n    queryParams: {},\n  })\n\n  if (isLoading || !data) {\n    return \u003cspan\u003eLoading...\u003c/span\u003e\n  }\n\n  return (\n    \u003cul\u003e\n      {data.map((pet) =\u003e (\n        \u003cli key={pet.id}\u003e{pet.name}\u003c/li\u003e\n      ))}\n    \u003c/ul\u003e\n  )\n}\n\nexport default PetsList\n```\n\n## Advanced usage\n\nOpenAPI kit exports a set of functions you can use in your own scripts to export types in multiple folders or choose to not export `react-query` hooks for example.\n\n```ts\nimport {\n  dereferenceDocument,\n  generateAPIClient,\n  generateReactQueryHooks,\n  generateTypeDefinitions,\n  parseDocument,\n} from 'openapi-kit'\n\nconst run = () =\u003e {\n  const document = await parseDocument('./pet-store.yml')\n  if (!document) {\n    return\n  }\n\n  generateTypeDefinitions(document, { outputFilePath: './client/generated/types.ts' })\n  generateTypeDefinitions(document, { outputFilePath: './api/generated/types.ts' })\n}\n\nrun()\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreeeg%2Fopenapi-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreeeg%2Fopenapi-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreeeg%2Fopenapi-kit/lists"}