@rtk-incubator/rtk-query-codegen-openapi

Code Generator

$3

This is a utility library meant to be used with RTK Query that will generate a typed API client from an OpenAPI schema.

$3

By default, running the CLI will only log the output to the terminal. You can either pipe this output to a new file, or you can specify an output file via CLI args.

#### Piping to a file (including react hooks generation)

``bash
npx @rtk-incubator/rtk-query-codegen-openapi --hooks https://petstore3.swagger.io/api/v3/openapi.json > petstore-api.generated.ts
`

#### Specifying an output file (including react hooks generation)

`bash
npx @rtk-incubator/rtk-query-codegen-openapi --file petstore-api.generated.ts --hooks https://petstore3.swagger.io/api/v3/openapi.json
`

#### Using a custom baseQuery

`bash
npx @rtk-incubator/rtk-query-codegen-openapi --file generated.api.ts --baseQuery ./customBaseQuery.ts:namedBaseQueryFn --hooks https://petstore3.swagger.io/api/v3/openapi.json
`

$3

- --exportName - change the name of the exported api (default: api)
- --reducerPath - change the name of the reducerPath (default: api)
- --baseQuery - specify a file with a custom baseQuery function. Optionally takes a named function in that file. (default: fetchBaseQuery - ex: ./customBaseQuery.ts:myCustomBaseQueryFn)
- --argSuffix - change the suffix of the arg type (default: ApiArg - ex: AddPetApiArg)
- --responseSuffix - change the suffix of the response type (default: ApiResponse - ex: AddPetApiResponse)
- --baseUrl - set the baseUrl when using fetchBaseQuery (will be ignored if you pass --baseQuery)
- --createApiImportPath - set the entry point to import createApi from. Currently only react is available. Defaults to react if --hooks is passed.
- --hooks - include React Hooks in the output (ex: export const { useGetModelQuery, useUpdateModelMutation } = api)
- --file - specify a filename to output to (ex: ./generated.api.ts`)

$3

View the RTK Query Code Generation docs