Penukar OpenAPI ke TypeScript

Tukar dokumen OpenAPI 3.x kepada jenis TypeScript sepenuhnya dalam pelayar anda dengan pilihan penjanaan openapi-typescript yang biasa.

Dokumen OpenAPI
Tampal dokumen OpenAPI 3.0 atau 3.1 dalam JSON atau YAML, import daripada fail, atau ambil daripada URL yang membenarkan CORS.
Output TypeScript
Jenis TypeScript yang dijana dihasilkan dengan aliran openapi-typescript yang selamat untuk pelayar dan pilihan di bawah.
/**
 * 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>;
Pilihan penjanaan
Laraskan jenis yang dijana tanpa mengubah dokumen sumber.

Apakah Penukar OpenAPI ke TypeScript?

Penukar OpenAPI ke TypeScript menukar dokumen OpenAPI 3.x kepada jenis TypeScript yang dijana terus dalam pelayar anda. Ia berguna apabila anda mahu pratonton jenis dengan pantas, fail deklarasi yang boleh dimuat turun, atau cara selamat untuk menguji pilihan openapi-typescript tanpa menghantar skema anda ke pelayan.

Bila Ia Sesuai Digunakan

Gunakan alat ini apabila anda sudah mempunyai skema OpenAPI dalam JSON atau YAML dan mahu model permintaan serta respons yang berjenis untuk aplikasi frontend, prototaip SDK, atau semakan API. Ia sangat membantu untuk membandingkan pilihan penjanaan sebelum anda melakukan commit pada output ke repositori anda.

Sebelum Menjana

Penulisan semula dalam pelayar ini menyokong dokumen OpenAPI 3.0 dan 3.1 yang telah dibundle. Jika skema anda masih mengandungi sasaran $ref luaran, bundle atau sebariskan dahulu, kemudian jana output TypeScript akhir di sini.