Konwerter OpenAPI do TypeScript

Konwertuj dokumenty OpenAPI 3.x na typy TypeScript bezpośrednio w przeglądarce, z popularnymi opcjami generowania openapi-typescript.

Dokument OpenAPI
Wklej dokument OpenAPI 3.0 lub 3.1 w JSON albo YAML, zaimportuj go z pliku albo pobierz z adresu URL z włączonym CORS.
Wynik TypeScript
Wygenerowane typy TypeScript są tworzone przez bezpieczny dla przeglądarki przepływ openapi-typescript i poniższe opcje.
/**
 * 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>;
Opcje generowania
Dopasuj wygenerowane typy bez zmieniania dokumentu źródłowego.

Czym jest OpenAPI To TypeScript Converter?

OpenAPI to TypeScript Converter zamienia dokument OpenAPI 3.x na wygenerowane typy TypeScript bezpośrednio w przeglądarce. Jest przydatny, gdy chcesz szybko podejrzeć typy, pobrać plik deklaracji albo bezpiecznie przetestować opcje openapi-typescript bez wysyłania schematu na serwer.

Kiedy Go Używać

Użyj tego narzędzia, gdy masz już schemat OpenAPI w JSON lub YAML i chcesz typowane modele żądań i odpowiedzi do aplikacji frontendowych, prototypów SDK albo przeglądów API. Jest szczególnie pomocne przy porównywaniu opcji generowania przed zapisaniem wyniku w repozytorium.

Zanim Wygenerujesz

Ta przepisana wersja w przeglądarce obsługuje zbundlowane dokumenty OpenAPI 3.0 i 3.1. Jeśli w schemacie nadal są zewnętrzne cele $ref, najpierw je zbundle’uj albo wbuduj, a potem wygeneruj tutaj końcowy wynik TypeScript.