ts-openapi-codegen 2.1.0-beta.4 → 2.1.0-beta.5

package/README.md

@@ -14,7 +14,6 @@
 ![lines-image]
 ![Minimum node.js version](https://badgen.net/npm/node/next)
 
-
 > Node.js library that generates Typescript clients based on the OpenAPI specification.
 
 ## Why?
@@ -34,966 +33,18 @@
 
 ## Install
 
-```
-npm install ts-openapi-codegen --save-dev
-```
-
-
-## Usage
-
-The CLI tool supports six commands: `generate`, `check-config`, `update-config`, `init`, `preview-changes`, and `analyze-diff`.
-
-### Command: `generate`
-
-Generates TypeScript client code based on OpenAPI specifications.
-
-**Basic usage:**
-```bash
-openapi generate --input ./spec.json --output ./dist
-```
-
-**All available options:**
-
-| Option | Short | Type | Default | Description |
-|--------|-------|------|---------|-------------|
-| `--input` | `-i` | string | - | OpenAPI specification (path, URL, or string content) - **required** |
-| `--output` | `-o` | string | - | Output directory - **required** |
-| `--openapi-config` | `-ocn` | string | `openapi.config.json` | Path to configuration file |
-| `--outputCore` | `-oc` | string | `{output}` | Output directory for core files |
-| `--outputServices` | `-os` | string | `{output}` | Output directory for services |
-| `--outputModels` | `-om` | string | `{output}` | Output directory for models |
-| `--outputSchemas` | `-osm` | string | `{output}` | Output directory for schemas |
-| `--httpClient` | `-c` | string | `fetch` | HTTP client to generate: `fetch`, `xhr`, `node`, or `axios` |
-| `--useOptions` | - | boolean | `false` | Use options instead of arguments |
-| `--useUnionTypes` | - | boolean | `false` | Use union types instead of enums |
-| `--excludeCoreServiceFiles` | - | boolean | `false` | Exclude generation of core and service files |
-| `--request` | - | string | - | Path to custom request file |
-| `--customExecutorPath` | - | string | - | Path to custom `createExecutorAdapter` module |
-| `--interfacePrefix` | - | string | `I` | Prefix for interface models |
-| `--enumPrefix` | - | string | `E` | Prefix for enum models |
-| `--typePrefix` | - | string | `T` | Prefix for type models |
-| `--useCancelableRequest` | - | boolean | `false` | Use cancelable promise as return type |
-| `--sortByRequired` | `-s` | boolean | `false` | Use extended sorting strategy for function arguments |
-| `--useSeparatedIndexes` | - | boolean | `false` | Use separate index files for core, models, schemas, and services |
-| `--strict-openapi` | - | boolean | `false` | Enable strict OpenAPI diagnostics and fail generation when strict errors are found |
-| `--report-file` | - | string | `./openapi-report.json` | Path to strict OpenAPI diagnostics report JSON file |
-| `--logLevel` | `-l` | string | `error` | Logging level: `info`, `warn`, or `error` |
-| `--logTarget` | `-t` | string | `console` | Logging target: `console` or `file` |
-| `--validationLibrary` | - | string | `none` | Validation library for schema generation: `none`, `zod`, `joi`, `yup`, or `jsonschema` |
-| `--emptySchemaStrategy` | - | string | `keep` | Strategy for empty schemas: `keep`, `semantic`, or `skip` |
-| `--modelsMode` | - | string | `interfaces` | Models generation mode: `interfaces` or `classes` |
-| `--useHistory` | - | boolean | `false` | Apply diff report annotations during generation |
-| `--diffReport` | - | string | `./openapi-diff-report.json` | Path to diff report JSON |
-| `--useProjectPrettier` | - | boolean | `false` | Use the project’s Prettier config to format generated code |
-| `--useEslintFix` | - | boolean | `false` | Run ESLint `--fix` on generated files after write (requires `eslint` in the project) |
-
-**Examples:**
-```bash
-# Basic generation
-openapi generate --input ./spec.json --output ./dist
-
-# With custom HTTP client
-openapi generate --input ./spec.json --output ./dist --httpClient axios
-
-# With configuration file
-openapi generate --openapi-config ./my-config.json
-
-# With all options via CLI
-openapi generate \
-  --input ./spec.json \
-  --output ./dist \
-  --httpClient fetch \
-  --useOptions \
-  --useUnionTypes \
-  --logLevel info
-```
-
-### Command: `check-config`
-
-Validates the configuration file structure and values.
-
-**Usage:**
-```bash
-openapi check-config
-openapi check-config --openapi-config ./custom-config.json
-```
-
-**Options:**
-- `--openapi-config` / `-ocn` - Path to configuration file (default: `openapi.config.json`)
-
-### Command: `update-config`
-
-Updates the configuration file to the latest supported schema version.
-
-**Usage:**
-```bash
-openapi update-config
-openapi update-config --openapi-config ./custom-config.json
-```
-
-**Options:**
-- `--openapi-config` / `-ocn` - Path to configuration file (default: `openapi.config.json`)
-
-### Command: `init`
-
-Generates a configuration file template.
-
-**Usage:**
-```bash
-# Generate config using default settings
-openapi init
-
-# Custom config file name
-openapi init --openapi-config ./my-config.json
-
-# Specify directory with OpenAPI specs
-openapi init --specs-dir ./openapi
-```
-
-**Options:**
-- `--openapi-config` / `-ocn` - Path to output configuration file (default: `openapi.config.json`)
-- `--specs-dir` / `-sd` - Directory with OpenAPI specification files (default: `./openapi`)
-- `--request` - Path to custom request file
-- `--useCancelableRequest` - Generate cancelable request handling
-- `--useInteractiveMode` - Enable interactive mode for guided setup
-
-### Command: `preview-changes`
-
-Previews differences between already generated code and newly generated output without overwriting your current generated directory.
-
-**Usage:**
-```bash
-openapi preview-changes
-openapi preview-changes --openapi-config ./custom-config.json
-```
-
-**Options:**
-- `--openapi-config` / `-ocn` - Path to configuration file (default: `openapi.config.json`)
-- `--generated-dir` / `-gd` - Directory with current generated files (default: `./generated`)
-- `--preview-dir` / `-pd` - Temporary preview generation directory (default: `./.ts-openapi-codegen-preview-changes`)
-- `--diff-dir` / `-dd` - Directory for diff reports (default: `./.ts-openapi-codegen-diff-changes`)
-
-### Command: `analyze-diff`
-
-Analyzes differences between two OpenAPI specifications and produces a JSON report.
-
-**Usage:**
 ```bash
-openapi analyze-diff --input ./openapi/current.yaml --compare-with ./openapi/previous.yaml --output-report ./openapi-diff-report.json
-openapi analyze-diff --input ./openapi/spec.yaml --git HEAD~1
-```
-
-**Options:**
-- `--input` / `-i` - Path to current OpenAPI specification file (required)
-- `--compare-with` - Path to previous OpenAPI specification file
-- `--git` - Git ref to read previous specification version from (e.g. `HEAD~1`)
-- `--output-report` - Path to save JSON diff report (default: `./openapi-diff-report.json`)
-
-#### Miracles and confirmation
-
-The diff report can contain a `miracles` section with detected renames/type-coercions. Only confirmed miracles are applied in generation.
-
-**How to confirm miracles:**
-1. Run `analyze-diff` and open the generated report (default: `./openapi-diff-report.json`).
-2. Find the entry in `miracles` you want to accept.
-3. Change `"status": "auto-generated"` to `"status": "confirmed"` and commit the report.
-
-Example (excerpt):
-```json
-{
-  "miracles": [
-    {
-      "oldPath": "$.components.schemas.User.properties.user_name",
-      "newPath": "$.components.schemas.User.properties.userName",
-      "type": "RENAME",
-      "confidence": 0.85,
-      "status": "confirmed"
-    }
-  ]
-}
-```
-
-### Configuration File
-
-Instead of passing all options via CLI, you can use a configuration file. Create `openapi.config.json` in your project root:
-
-**Single options format:**
-```json
-{
-    "input": "./spec.json",
-    "output": "./dist",
-    "client": "fetch",
-    "useOptions": false,
-    "useUnionTypes": false,
-    "excludeCoreServiceFiles": false,
-    "interfacePrefix": "I",
-    "enumPrefix": "E",
-    "typePrefix": "T",
-    "useCancelableRequest": false,
-    "sortByRequired": false,
-    "useSeparatedIndexes": false,
-    "request": "./custom-request.ts",
-    "customExecutorPath": "./custom/createExecutorAdapter.ts",
-    "modelsMode": "interfaces",
-    "useHistory": false,
-    "diffReport": "./openapi-diff-report.json",
-    "models": {
-        "mode": "interfaces"
-    },
-    "analyze": {
-        "useHistory": false,
-        "reportPath": "./openapi-diff-report.json"
-    },
-    "miracles": {
-        "enabled": true,
-        "confidence": 1,
-        "types": ["RENAME", "TYPE_COERCION"]
-    },
-    "plugins": ["./plugins/custom-type.plugin.cjs"],
-    "customExecutorPath": "./custom/createExecutorAdapter.ts"
-}
-```
-
-**Multi-options format (with common block):**
-```json
-{
-    "output": "./dist",
-    "client": "fetch",
-    "excludeCoreServiceFiles": true,
-    "items": [
-        {
-            "input": "./first.yml"
-        },
-        {
-            "input": "./second.yml",
-            "output": "./dist-v2"
-        }
-    ]
-}
-```
-
-**Array format (multiple configs):**
-```json
-[
-    {
-        "input": "./first.yml",
-        "output": "./dist",
-        "client": "xhr"
-    },
-    {
-        "input": "./second.yml",
-        "output": "./dist",
-        "client": "fetch"
-    }
-]
-```
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `input` | string | - | OpenAPI specification path/URL (required for items) |
-| `output` | string | - | Output directory (required) |
-| `outputCore` | string | `{output}` | Output directory for core files |
-| `outputServices` | string | `{output}` | Output directory for services |
-| `outputModels` | string | `{output}` | Output directory for models |
-| `outputSchemas` | string | `{output}` | Output directory for schemas |
-| `client` | string | `fetch` | HTTP client: `fetch`, `xhr`, `node`, or `axios` |
-| `useOptions` | boolean | `false` | Use options instead of arguments |
-| `useUnionTypes` | boolean | `false` | Use union types instead of enums |
-| `excludeCoreServiceFiles` | boolean | `false` | Exclude core and service files generation |
-| `request` | string | - | Path to custom request file |
-| `plugins` | string[] | `[]` | Paths to generator plugins |
-| `customExecutorPath` | string | - | Path to custom `createExecutorAdapter` module |
-| `interfacePrefix` | string | `I` | Prefix for interface models |
-| `enumPrefix` | string | `E` | Prefix for enum models |
-| `typePrefix` | string | `T` | Prefix for type models |
-| `useCancelableRequest` | boolean | `false` | Use cancelable promise as return type |
-| `sortByRequired` | boolean | `false` | Extended sorting strategy for arguments |
-| `useSeparatedIndexes` | boolean | `false` | Use separate index files |
-| `strictOpenapi` | boolean | `false` | Enable strict OpenAPI diagnostics and fail generation on strict errors |
-| `reportFile` | string | `./openapi-report.json` | Path to strict OpenAPI diagnostics report JSON file |
-| `items` | array | - | Array of configurations (for multi-options format) |
-| `validationLibrary` | string | `none` | Validation library for schema generation: `none`, `zod`, `joi`, `yup`, or `jsonschema` |
-| `emptySchemaStrategy` | string | `keep` | Strategy for empty schemas: `keep`, `semantic`, or `skip` |
-| `modelsMode` | string | `interfaces` | Models generation mode: `interfaces` or `classes` |
-| `useHistory` | boolean | `false` | Apply diff report annotations during generation |
-| `diffReport` | string | `./openapi-diff-report.json` | Path to diff report JSON |
-| `models` | object | - | Models config section (e.g. `mode`) |
-| `analyze` | object | - | Analyze config section (e.g. reportPath, useHistory, ignore) |
-| `miracles` | object | - | Miracles config section (enabled, confidence, types) |
-
-**Note:** You can use the `init` command to generate a template configuration file.
-
-### Plugins
-
-Generator plugins can override schema type mapping (for example via `x-typescript-type`) and extend generation behavior.
-
-- Configuration key: `plugins` (array of module paths)
-- Supported module formats: CJS, ESM, and TS (when runtime supports TS imports)
-- Full guide: [docs/plugins.md](./docs/plugins.md)
-
-## Examples
-
-### Using CLI commands
-
-**Basic generation:**
-```bash
-openapi generate --input ./spec.json --output ./dist
-```
-
-**With configuration file:**
-```bash
-# First, create config file
-openapi init
-
-# Then generate
-openapi generate
-```
-
-**With DTO models (classes mode):**
-```bash
-openapi generate --input ./spec.json --output ./dist --modelsMode classes
-```
-
-**Generate diff report:**
-```bash
-openapi analyze-diff --input ./openapi/current.yaml --compare-with ./openapi/previous.yaml --output-report ./openapi-diff-report.json
-```
-
-**Check configuration:**
-```bash
-openapi check-config
-openapi update-config
-```
-
-**Preview changes before applying:**
-```bash
-openapi preview-changes
-```
-
-### Using NPX
-
-```bash
-npx ts-openapi-codegen generate --input ./spec.json --output ./dist
-```
-
-### Using package.json scripts
-
-**package.json**
-```json
-{
-    "scripts": {
-        "generate": "openapi generate --input ./spec.json --output ./dist",
-        "generate:config": "openapi generate",
-        "check-config": "openapi check-config",
-        "update-config": "openapi update-config",
-        "init-config": "openapi init",
-        "preview-changes": "openapi preview-changes"
-    }
-}
-```
-
-### Node.js API
-
-```javascript
-const OpenAPI = require('ts-openapi-codegen');
-
-OpenAPI.generate({
-    input: './spec.json',
-    output: './dist'
-});
-
-// Or by providing the content of the spec directly 🚀
-OpenAPI.generate({
-    input: require('./spec.json'),
-    output: './dist'
-});
-```
-
-
-## Features
-
-### HTTP Clients
-
-The generator supports multiple HTTP clients:
-- **fetch** (default) - Browser Fetch API
-- **xhr** - XMLHttpRequest
-- **node** - Node.js compatible client using `node-fetch`
-- **axios** - Axios HTTP client
-
-Select the client using the `--httpClient` option or `client` property in config file.
-
-### Argument style vs. Object style `--useOptions`
-There's no [named parameter](https://en.wikipedia.org/wiki/Named_parameter) in JavaScript or TypeScript, because of
-that, we offer the flag `--useOptions` to generate code in two different styles.
-
-**Argument-style:**
-```typescript
-function createUser(name: string, password: string, type?: string, address?: string) {
-    // ...
-}
-
-// Usage
-createUser('Jack', '123456', undefined, 'NY US');
-```
-
-**Object-style:**
-```typescript
-function createUser({ name, password, type, address }: {
-    name: string,
-    password: string,
-    type?: string
-    address?: string
-}) {
-    // ...
-}
-
-// Usage
-createUser({
-    name: 'Jack',
-    password: '123456',
-    address: 'NY US'
-});
-```
-
-### Enums vs. Union Types `--useUnionTypes`
-The OpenAPI spec allows you to define [enums](https://swagger.io/docs/specification/data-models/enums/) inside the
-data model. By default, we convert these enums definitions to [TypeScript enums](https://www.typescriptlang.org/docs/handbook/enums.html).
-However, these enums are merged inside the namespace of the model, this is unsupported by Babel, [see docs](https://babeljs.io/docs/en/babel-plugin-transform-typescript#impartial-namespace-support).
-Because we also want to support projects that use Babel [@babel/plugin-transform-typescript](https://babeljs.io/docs/en/babel-plugin-transform-typescript),
-we offer the flag `--useUnionTypes` to generate [union types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-types)
-instead of the traditional enums. The difference can be seen below:
-
-**Enums:**
-```typescript
-// Model
-export interface Order {
-    id?: number;
-    quantity?: number;
-    status?: Order.status;
-}
-
-export namespace Order {
-    export enum status {
-        PLACED = 'placed',
-        APPROVED = 'approved',
-        DELIVERED = 'delivered',
-    }
-}
-
-// Usage
-const order: Order = {
-    id: 1,
-    quantity: 40,
-    status: Order.status.PLACED
-}
-```
-
-**Union Types:**
-```typescript
-// Model
-export interface Order {
-    id?: number;
-    quantity?: number;
-    status?: 'placed' | 'approved' | 'delivered';
-}
-
-// Usage
-const order: Order = {
-    id: 1,
-    quantity: 40,
-    status: 'placed'
-}
-```
-
-### Validation schemas `--validationLibrary`
-By default, the OpenAPI generator only exports interfaces for your models. These interfaces will help you during
-development, but will not be available in JavaScript during runtime. However, OpenAPI allows you to define properties
-that can be useful during runtime, for instance: `maxLength` of a string or a `pattern` to match, etc.
-
-The `--validationLibrary` parameter allows you to generate runtime validation schemas using popular validation libraries:
-- **none** (default) - No validation schemas generated
-- **zod** - Generate Zod validation schemas
-- **joi** - Generate Joi validation schemas
-- **yup** - Generate Yup validation schemas
-- **jsonschema** - Generate JSON Schema validation schemas
-
-When `--useHistory` is enabled and a diff report marks a type change, validators will attempt to coerce values:
-- **Zod** uses `z.coerce.*`
-- **Joi** uses `Joi.alternatives().try(...)`
-- **Yup** uses `.transform(...)`
-- **JSON Schema (AJV)** enables `coerceTypes`
-
-### Models mode `--modelsMode`
-
-By default, models are generated as TypeScript interfaces/types. When `--modelsMode classes` is used, the generator produces:
-- `*Raw` interfaces matching the API JSON
-- `*Dto` classes with getters, defaults, recursive constructors, and `toJSON()`
-
-The output is consolidated into a single `models.ts` file, and `BaseDto`/`dtoUtils` are emitted in `core`.
-
-Let's say we have the following model:
-
-```json
-{
-    "MyModel": {
-        "required": [
-            "key",
-            "name"
-        ],
-        "type": "object",
-        "properties": {
-            "key": {
-                "maxLength": 64,
-                "pattern": "^[a-zA-Z0-9_]*$",
-                "type": "string"
-            },
-            "name": {
-                "maxLength": 255,
-                "type": "string"
-            },
-            "enabled": {
-                "type": "boolean",
-                "readOnly": true
-            },
-            "modified": {
-                "type": "string",
-                "format": "date-time",
-                "readOnly": true
-            }
-        }
-    }
-}
-```
-
-**With Zod (`--validationLibrary zod`):**
-
-```ts
-import { z } from 'zod';
-
-export const MyModelSchema = z.object({
-    key: z.string().max(64).regex(/^[a-zA-Z0-9_]*$/),
-    name: z.string().max(255),
-    enabled: z.boolean().readonly().optional(),
-    modified: z.string().datetime().readonly().optional(),
-});
-
-export type MyModel = z.infer<typeof MyModelSchema>;
-
-export function validateMyModel(data: unknown): MyModel {
-    return MyModelSchema.parse(data);
-}
-
-export function safeValidateMyModel(data: unknown): { success: true; data: MyModel } | { success: false; error: z.ZodError } {
-    const result = MyModelSchema.safeParse(data);
-    if (result.success) {
-        return { success: true, data: result.data };
-    }
-    return { success: false, error: result.error };
-}
-```
-
-**With Joi (`--validationLibrary joi`):**
-
-```ts
-import Joi from 'joi';
-
-export const MyModelSchema = Joi.object({
-    key: Joi.string().max(64).pattern(/^[a-zA-Z0-9_]*$/).required(),
-    name: Joi.string().max(255).required(),
-    enabled: Joi.boolean().readonly(),
-    modified: Joi.string().isoDate().readonly(),
-});
-```
-
-**With Yup (`--validationLibrary yup`):**
-
-```ts
-import * as yup from 'yup';
-
-export const MyModelSchema = yup.object({
-    key: yup.string().max(64).matches(/^[a-zA-Z0-9_]*$/).required(),
-    name: yup.string().max(255).required(),
-    enabled: yup.boolean().readonly(),
-    modified: yup.string().datetime().readonly(),
-});
-```
-
-**With JSON Schema (`--validationLibrary jsonschema`):**
-
-```ts
-export const MyModelSchema = {
-    type: 'object',
-    required: ['key', 'name'],
-    properties: {
-        key: {
-            type: 'string',
-            maxLength: 64,
-            pattern: '^[a-zA-Z0-9_]*$',
-        },
-        name: {
-            type: 'string',
-            maxLength: 255,
-        },
-        enabled: {
-            type: 'boolean',
-            readOnly: true,
-        },
-        modified: {
-            type: 'string',
-            format: 'date-time',
-            readOnly: true,
-        },
-    },
-};
-```
-These validation schemas can be used for form generation, input validation, and runtime type checking in your application.
-
-### Cancelable promise `--useCancelableRequest`
-By default, the OpenAPI generator generates services for accessing the API that use non-cancellable requests. Therefore, we have added the ability to switch the generator to generate canceled API requests. To do this, use the flag `--useCancelableRequest`.
-An example of a cancelled request would look like this:
-
-```typescript
-export function request<T>(config: TOpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> {
-    return new CancelablePromise(async(resolve, reject, onCancel) => {
-        const url = `${config.BASE}${options.path}`.replace('{api-version}', config.VERSION);
-        try {
-            if (!onCancel.isCancelled) {
-                const response = await sendRequest(options, url, config, onCancel);
-                const responseBody = await getResponseBody(response);
-                const responseHeader = getResponseHeader(response, options.responseHeader);
-                const result: ApiResult = {
-                    url,
-                    ok: response.ok,
-                    status: response.status,
-                    statusText: response.statusText,
-                    body: responseHeader || responseBody,
-                };
-
-                catchErrors(options, result);
-                resolve(result.body);
-            }
-        } catch (e) {
-            reject(e);
-        }
-    });
-}
-```
-
-### RequestExecutor
-
-Starting from version **2.0.0** the generated services use the `RequestExecutor` interface
-instead of direct calls to the `request` core function.
-
-The `RequestExecutor` is a single HTTP logic integration point responsible for executing requests
-and extending client behavior. It allows you to:
-- use any transport (fetch/axios/xhr/custom);
-- Centrally handle requests, responses, and errors;
-- expand the client's behavior without changing the generated services.
-
-#### Interceptors
-
-`RequestExecutor` supports **interceptors**, which allow you to implement additional
-logic at different stages of the request lifecycle.:
-
-- `onRequest` — modification of the request before sending (headers, auth, logging);
-- `onResponse` — processing successful responses;
-- `onError` — centralized error handling.
-
-Interceptors are applied at the executor level and are automatically used by all
-generated services.
-
-```ts
-import { createClient } from './generated';
-
-const client = createClient({
-    interceptors: {
-        onRequest: [
-            (config) => ({
-                ...config,
-                headers: {
-                    ...config.headers,
-                    Authorization: 'Bearer token',
-                },
-            }),
-        ],
-        onError: [
-            (error) => {
-                console.error(error);
-                throw error;
-            },
-        ],
-    },
-});
-```
-
-#### Custom implementation of RequestExecutor with interceptors
-
-A custom `RequestExecutor` can be used together with interceptors.
-In this case, the executor is responsible only for the transport and execution of the request,
-while the interceptors are responsible for the extensible business logic (authorization, logging, error handling).
-
-```ts
-import type { RequestExecutor, RequestConfig } from './generated/core/executor/requestExecutor';
-import { withInterceptors } from './generated/core/interceptors/withInterceptors';
-import { SimpleService } from './generated/services/SimpleService';
-
-interface MyCustomOptions {
-    timeout?: number;
-}
-
-const baseExecutor: RequestExecutor<MyCustomOptions> = {
-    async request<T>(config: RequestConfig, options?: MyCustomOptions): Promise<T> {
-        const response = await fetch(config.url, {
-            method: config.method,
-            headers: config.headers,
-            body: config.body ? JSON.stringify(config.body) : undefined,
-            signal: options?.timeout
-                ? AbortSignal.timeout(options.timeout)
-                : undefined,
-        });
-
-        if (!response.ok) {
-            throw new Error(`Request failed: ${response.status}`);
-        }
-
-        return response.json();
-    },
-};
-
-// Wrapping the executor interceptors
-const executor = withInterceptors(baseExecutor, {
-    onRequest: [
-        (config) => ({
-            ...config,
-            headers: {
-                ...config.headers,
-                Authorization: 'Bearer token',
-            },
-        }),
-    ],
-    onError: [
-        (error) => {
-            console.error(error);
-            throw error;
-        },
-    ],
-});
-
-const service = new SimpleService(executor);
-await service.getCallWithoutParametersAndResponse({ timeout: 5000 });
-```
-
-#### Using generated `createClient` with `customExecutorPath` and `executorFactory`
-
-If you set `customExecutorPath` in generation config, `createClient.ts` imports your custom
-`createExecutorAdapter` and uses it as the default executor.
-
-You can additionally pass `executorFactory` at runtime to wrap/extend this default executor
-(for retry, tracing, metrics, etc.) without changing generated services.
-
-```ts
-import { createClient } from './generated';
-
-const client = createClient({
-    executorFactory: ({ openApiConfig, createDefaultExecutor }) => {
-        const baseExecutor = createDefaultExecutor();
-
-        return {
-            async request<TResponse>(config, options) {
-                console.debug('Request to', openApiConfig.BASE, config.path);
-                return baseExecutor.request<TResponse>(config, options);
-            },
-        };
-    },
-});
-```
-
-### Sorting strategy for function arguments `--sortByRequired`
-By default, the OpenAPI generator sorts the parameters of service functions according to a simplified scheme. If you need a more strict sorting option, then you need to use the `--sortByRequired` flag. The simplified sorting option is similar to the one used in version 0.2.3 of the OpenAPI generator. This flag allows you to upgrade to a new version of the generator if you are "stuck" on version 0.2.3.
-
-### Separate index files `--useSeparatedIndexes`
-By default, the generator creates a single index file that exports all generated code. With the `--useSeparatedIndexes` flag, you can generate separate index files for core, models, schemas, and services, which can help with better code organization and tree-shaking.
-
-### Enum with custom names and descriptions
-You can use `x-enum-varnames` and `x-enum-descriptions` in your spec to generate enum with custom names and descriptions.
-It's not in official [spec](https://github.com/OAI/OpenAPI-Specification/issues/681) yet. But it's a supported extension
-that can help developers use more meaningful enumerators.
-```json
-{
-    "EnumWithStrings": {
-        "description": "This is a simple enum with strings",
-        "enum": [
-            0,
-            1,
-            2
-        ],
-        "x-enum-varnames": [
-            "Success",
-            "Warning",
-            "Error"
-        ],
-        "x-enum-descriptions": [
-            "Used when the status of something is successful",
-            "Used when the status of something has a warning",
-            "Used when the status of something has an error"
-        ]
-    }
-}
-```
-
-Generated code:
-```typescript
-enum EnumWithStrings {
-    /*
-    * Used when the status of something is successful
-    */
-    Success = 0,
-    /*
-    * Used when the status of something has a warning
-    */
-    Waring = 1,
-    /*
-    * Used when the status of something has an error
-    */
-    Error = 2,
-}
-```
-
-
-### Nullable in OpenAPI v2
-In the OpenAPI v3 spec you can create properties that can be NULL, by providing a `nullable: true` in your schema.
-However, the v2 spec does not allow you to do this. You can use the unofficial `x-nullable` in your specification
-to generate nullable properties in OpenApi v2.
-
-```json
-{
-    "ModelWithNullableString": {
-        "required": ["requiredProp"],
-        "description": "This is a model with one string property",
-        "type": "object",
-        "properties": {
-            "prop": {
-                "description": "This is a simple string property",
-                "type": "string",
-                "x-nullable": true
-            },
-            "requiredProp": {
-                "description": "This is a simple string property",
-                "type": "string",
-                "x-nullable": true
-            }
-        }
-    }
-}
-```
-
-Generated code:
-```typescript
-interface ModelWithNullableString {
-    prop?: string | null,
-    requiredProp: string | null,
-}
-```
-
-
-### Authorization
-The OpenAPI generator supports Bearer Token authorization. In order to enable the sending
-of tokens in each request you can set the token using the global OpenAPI configuration:
-
-```typescript
-import { OpenAPI } from './generated';
-
-OpenAPI.TOKEN = 'some-bearer-token';
-```
-
-Alternatively, we also support an async method that provides the token for each request.
-You can simply assign this method to the same `TOKEN `property in the global OpenAPI object.
-
-```typescript
-import { OpenAPI } from './generated';
-
-const getToken = async () => {
-    // Some code that requests a token...
-    return 'SOME_TOKEN';
-}
-
-OpenAPI.TOKEN = getToken;
-```
-
-### References
-
-Local references to schema definitions (those beginning with `#/definitions/schemas/`)
-will be converted to type references to the equivalent, generated top-level type.
-
-The OpenAPI generator also supports external references, which allows you to break
-down your openapi.yml into multiple sub-files, or incorporate third-party schemas
-as part of your types to ensure everything is able to be TypeScript generated.
-
-External references may be:
-* *relative references* - references to other files at the same location e.g.
-    `{ $ref: 'schemas/customer.yml' }`
-* *remote references* - fully qualified references to another remote location
-     e.g. `{ $ref: 'https://myexampledomain.com/schemas/customer_schema.yml' }`
-
-    For remote references, both files (when the file is on the current filesystem)
-    and http(s) URLs are supported.
-
-External references may also contain internal paths in the external schema (e.g.
-`schemas/collection.yml#/definitions/schemas/Customer`) and back-references to
-the base openapi file or between files (so that you can reference another
-schema in the main file as a type of an object or array property, for example).
-
-At start-up, an OpenAPI or Swagger file with external references will be "bundled",
-so that all external references and back-references will be resolved (but local
-references preserved).
-
-FAQ
-===
-
-### Babel support
-If you use enums inside your models / definitions then those enums are by default inside a namespace with the same name
-as your model. This is called declaration merging. However, the [@babel/plugin-transform-typescript](https://babeljs.io/docs/en/babel-plugin-transform-typescript)
-does not support these namespaces, so if you are using babel in your project please use the `--useUnionTypes` flag
-to generate union types instead of traditional enums. More info can be found here: [Enums vs. Union Types](#enums-vs-union-types---useuniontypes).
-
-**Note:** If you are using Babel 7 and Typescript 3.8 (or higher) then you should enable the `onlyRemoveTypeImports` to
-ignore any 'type only' imports, see https://babeljs.io/docs/en/babel-preset-typescript#onlyremovetypeimports for more info
-
-```javascript
-module.exports = {
-    presets: [
-        ['@babel/preset-typescript', {
-            onlyRemoveTypeImports: true,
-        }],
-    ],
-};
-```
-
-
-### Node.js support
-By default, this library will generate a client that is compatible with the (browser based) [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API),
-however this client will not work inside the Node.js environment. If you want to generate a Node.js compatible client then
-you can specify `--httpClient node` in the openapi call:
-
-`openapi generate --input ./spec.json --output ./dist --httpClient node`
-
-This will generate a client that uses [`node-fetch`](https://www.npmjs.com/package/node-fetch) internally. However,
-in order to compile and run this client, you will need to install the `node-fetch` dependencies:
-
-```
-npm install @types/node-fetch --save-dev
-npm install node-fetch --save-dev
-npm install form-data --save-dev
+npm install ts-openapi-codegen --save-dev
 ```
 
-In order to compile the project and resolve the imports, you will need to enable the `allowSyntheticDefaultImports`
-in your `tsconfig.json` file.
+## Documentation
 
-```json
-{
-    "allowSyntheticDefaultImports": true
-}
-```
+- [Usage](docs/en/usage.md)
+- [Configuration file](docs/en/configuration.md)
+- [Examples](docs/en/examples.md)
+- [Features](docs/en/features.md)
+- [Русская версия README](README.rus.md)
+- [Русская документация](docs/ru/usage.md)
 
 [npm-url]: https://www.npmjs.com/package/ts-openapi-codegen
 [npm-image]: https://img.shields.io/npm/v/ts-openapi-codegen.svg