@acrool/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

- Local Schema File Support: Direct processing of local schema files via schemaFile
- Remote Schema Download: Download remote schemas to local files via remoteFile and schemaFile
- Type Generation: Generates TypeScript types from OpenAPI schemas
- RTK Query Integration: Seamless integration with RTK Query

$3

- schemaFile: The local OpenAPI schema file path (required)
- remoteFile: (Optional) Remote schema URL to download to schemaFile path
- outputFile: The output file path for generated code
- apiFile: The base API file path

$3

``typescript
// For remote schemas with download
{
schemaFile: './schemas/api-schema.json',
remoteFile: 'https://api.example.com/openapi.json',
apiFile: './baseApi',
outputFile: './generated-api.ts'
}

// For local schema files
{
schemaFile: './schemas/api-schema.json',
apiFile: './baseApi',
outputFile: './generated-api.ts'
}
`

$3

View the RTK Query Code Generation docs

$3

`bash
yarn cli ./react-rtk-query.config.ts
``

Step

1. [endpoint-generator] EndpointGenerator.generateEndpoints....
2. [endpoint-generator] EndpointGenerator.generateForGroup.......
2.1. [generate-new] generateApi........
2. [endpoint-generator] EndpointGenerator.generateForGroup.......
2.1. [generate-new] generateApi........