Konverter OpenAPI ke TypeScript

Ubah dokumen OpenAPI 3.x menjadi tipe TypeScript sepenuhnya di browser dengan opsi generasi openapi-typescript yang umum.

Dokumen OpenAPI
Tempel dokumen OpenAPI 3.0 atau 3.1 dalam JSON atau YAML, impor dari file, atau ambil dari URL yang mengizinkan CORS.
Output TypeScript
Tipe TypeScript yang dihasilkan dibuat dengan pipeline openapi-typescript yang aman di browser dan opsi di bawah ini.
/**
 * 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>;
Opsi generasi
Atur tipe yang dihasilkan tanpa mengubah dokumen sumber.

Apa Itu OpenAPI To TypeScript Converter?

OpenAPI to TypeScript Converter mengubah dokumen OpenAPI 3.x menjadi tipe TypeScript yang dihasilkan langsung di browser. Ini berguna saat Anda ingin pratinjau tipe yang cepat, file deklarasi yang bisa diunduh, atau cara aman untuk mencoba opsi openapi-typescript tanpa mengirim skema ke server.

Kapan Menggunakannya

Gunakan alat ini saat Anda sudah punya skema OpenAPI dalam JSON atau YAML dan ingin model request dan response bertipe untuk aplikasi frontend, prototipe SDK, atau peninjauan API. Alat ini sangat membantu untuk membandingkan opsi generasi sebelum menyimpan hasilnya ke repositori.

Sebelum Menghasilkan

Rewrite browser ini mendukung dokumen OpenAPI 3.0 dan 3.1 yang sudah dibundle. Jika skema Anda masih memuat target $ref eksternal, bundle atau inline dulu, lalu hasilkan output TypeScript final di sini.