sohcah Libraries

OpenAPI Generator

Getting Started

Installation

npm install --save-dev @sohcah/openapi-generator

Peer Dependencies

The generated source from the OpenAPI Generator requires @tanstack/react-query and zod.

npm install @tanstack/react-query zod

Usage

openapi.config.ts
import { defineConfig } from "@sohcah/openapi-generator/config";
import {
  createReactQueryClientGenerator,
  createZodSchemaGenerator,
} from "@sohcah/openapi-generator/generators";

export default defineConfig({
  schema: "swagger.json",
  output: "src/api.ts",
  generators: [
    createReactQueryClientGenerator({
      schema: createZodSchemaGenerator({}),
    }),
  ],
});
package.json
{
  "scripts": {
    "openapi-build": "openapi-generator build",
    "openapi-dev": "openapi-generator watch"
  }
}

On this page