Конвертер OpenAPI в TypeScript

Преобразуйте документы OpenAPI 3.x в типы TypeScript прямо в браузере с распространенными параметрами генерации openapi-typescript.

Документ OpenAPI
Вставьте документ OpenAPI 3.0 или 3.1 в формате JSON или YAML, импортируйте его из файла или загрузите по URL с поддержкой CORS.
Вывод TypeScript
Сгенерированные типы TypeScript создаются через безопасный для браузера конвейер openapi-typescript и параметры ниже.
/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
    "/users": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get: {
            parameters: {
                query?: never;
                header?: never;
                path?: never;
                cookie?: never;
            };
            requestBody?: never;
            responses: {
                /** @description OK */
                200: {
                    headers: {
                        [name: string]: unknown;
                    };
                    content: {
                        "application/json": components["schemas"]["User"][];
                    };
                };
            };
        };
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
}
export type webhooks = Record<string, never>;
export interface components {
    schemas: {
        User: {
            id: string;
            name: string;
            /** @enum {string} */
            role?: "admin" | "editor" | "viewer";
        };
    };
    responses: never;
    parameters: never;
    requestBodies: never;
    headers: never;
    pathItems: never;
}
export type $defs = Record<string, never>;
export type operations = Record<string, never>;
Параметры генерации
Настройте сгенерированные типы, не изменяя исходный документ.

Что такое конвертер OpenAPI в TypeScript?

OpenAPI to TypeScript Converter превращает документ OpenAPI 3.x в сгенерированные типы TypeScript прямо в браузере. Это полезно, когда нужен быстрый предпросмотр типов, загружаемый файл деклараций или безопасная проверка параметров openapi-typescript без отправки схемы на сервер.

Когда его использовать?

Используйте этот инструмент, если у вас уже есть схема OpenAPI в JSON или YAML и нужны типизированные модели запросов и ответов для frontend-приложений, прототипов SDK или ревью API. Он особенно полезен, когда вы сравниваете варианты генерации перед тем, как добавить результат в репозиторий.

Перед генерацией

Эта браузерная версия поддерживает собранные документы OpenAPI 3.0 и 3.1. Если в схеме еще остались внешние цели $ref, сначала соберите или встроите их, а затем сгенерируйте здесь финальный вывод TypeScript.