Node.js library that generates React Query (also called TanStack Query) hooks based on an OpenAPI specification file.
- Generates custom react hooks that use React Query's
useQuery,useSuspenseQueryanduseMutationhooks - Generates query keys and functions for query caching
- Generates pure TypeScript clients generated by @hey-api/openapi-ts
$ npm install -D @7nohe/openapi-react-query-codegen Register the command to the scripts property in your package.json file.
{"scripts":{"codegen": "openapi-rq -i ./petstore.yaml -c axios" } }You can also run the command without installing it in your project using the npx command.
$ npx --package @7nohe/openapi-react-query-codegen openapi-rq -i ./petstore.yaml -c axios$ openapi-rq --help Usage: openapi-rq [options] Generate React Query code based on OpenAPI Options: -V, --version output the version number -i, --input <value> OpenAPI specification, can be a path, url or string content (required) -o, --output <value> Output directory (default: "openapi") -c, --client <value> HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch") --request <value> Path to custom request file --format <value> Process output folder with formatter? ['biome', 'prettier'] --lint <value> Process output folder with linter? ['eslint', 'biome'] --operationId Use operation ID to generate operation names? --serviceResponse <value> Define shape of returned value from service calls ['body', 'response'] (default: "body") --base <value> Manually set base in OpenAPI config instead of inferring from server value --enums <value> Generate JavaScript objects from enum definitions? ['javascript', 'typescript'] --useDateType Use Date type instead of string for date types for models, this will not convert the data to a Date object --debug Enable debug mode --noSchemas Disable generating schemas for request and response objects --schemaTypes <value> Define the type of schema generation ['form', 'json'] (default: "json") -h, --help display help for command $ openapi-rq -i ./petstore.yaml - openapi - queries - index.ts <- main file that exports common types, variables, and queries. Does not export suspense or prefetch hooks - common.ts <- common types - queries.ts <- generated query hooks - suspenses.ts <- generated suspense hooks - prefetch.ts <- generated prefetch hooks learn more about prefetching in in link below - requests <- output code generated by @hey-api/openapi-ts // App.tsximport{usePetServiceFindPetsByStatus}from"../openapi/queries";functionApp(){const{ data }=usePetServiceFindPetsByStatus({status: ["available"]});return(<divclassName="App"><h1>Pet List</h1><ul>{data?.map((pet)=><likey={pet.id}>{pet.name}</li>)}</ul></div>);}exportdefaultApp;import{useQuery}from"@tanstack/react-query";import{PetService}from"../openapi/requests/services";import{usePetServiceFindPetsByStatusKey}from"../openapi/queries";functionApp(){// You can still use the auto-generated query keyconst{ data }=useQuery({queryKey: [usePetServiceFindPetsByStatusKey],queryFn: ()=>{// Do something herereturnPetService.findPetsByStatus(["available"]);},});return<divclassName="App">{/* .... */}</div>;}exportdefaultApp;// App.tsximport{useDefaultClientFindPetsSuspense}from"../openapi/queries/suspense";functionChildComponent(){const{ data }=useDefaultClientFindPetsSuspense({tags: [],limit: 10});return<ul>{data?.map((pet,index)=><likey={pet.id}>{pet.name}</li>)}</ul>;}functionParentComponent(){return(<><Suspensefallback={<>loading...</>}><ChildComponent/></Suspense></>);}functionApp(){return(<divclassName="App"><h1>Pet List</h1><ParentComponent/></div>);}exportdefaultApp;// App.tsximport{usePetServiceAddPet}from"../openapi/queries";functionApp(){const{ mutate }=usePetServiceAddPet();consthandleAddPet=()=>{mutate({name: "Fluffy",status: "available"});};return(<divclassName="App"><h1>Add Pet</h1><buttononClick={handleAddPet}>Add Pet</button></div>);}exportdefaultApp;Invalidating queries after a mutation is important to ensure the cache is updated with the new data. This is done by calling the queryClient.invalidateQueries function with the query key used by the query hook.
Learn more about invalidating queries here.
To ensure the query key is created the same way as the query hook, you can use the query key function exported by the generated query hooks.
import{usePetServiceFindPetsByStatus,usePetServiceAddPet,UsePetServiceFindPetsByStatusKeyFn,}from"../openapi/queries";// App.tsxfunctionApp(){const[status,setStatus]=React.useState(["available"]);const{ data }=usePetServiceFindPetsByStatus({ status });const{ mutate }=usePetServiceAddPet({onSuccess: ()=>{queryClient.invalidateQueries({// Call the query key function to get the query key// This is important to ensure the query key is created the same way as the query hook// This insures the cache is invalidated correctly and is typed correctlyqueryKey: [UsePetServiceFindPetsByStatusKeyFn({ status })],});},});return(<divclassName="App"><h1>Pet List</h1><ul>{data?.map((pet)=><likey={pet.id}>{pet.name}</li>)}</ul><buttononClick={()=>{mutate({name: "Fluffy",status: "available"});}}> Add Pet </button></div>);}exportdefaultApp;You can modify the default values used by the generated service calls by modifying the OpenAPI configuration singleton object.
It's default location is openapi/requests/core/OpenAPI.ts and it is also exported from openapi/index.ts
Import the constant into your runtime and modify it before setting up the react app.
/** main.tsx */import{OpenAPIasOpenAPIConfig}from'./openapi/requests/core/OpenAPI'; ... OpenAPIConfig.BASE='www.domain.com/api';OpenAPIConfig.HEADERS={'x-header-1': 'value-1','x-header-2': 'value-2',}; ... ReactDOM.createRoot(document.getElementById("root")asHTMLElement).render(<React.StrictMode><QueryClientProviderclient={queryClient}><App/></QueryClientProvider></React.StrictMode>);pnpm installpnpm testpnpm lintpnpm lint:fixpnpm snapshotnpm run build && pnpm --filter @7nohe/react-app generate:api && pnpm --filter @7nohe/react-app test:generated MIT