OpenAPI'den TypeScript'e Dönüştürücü

OpenAPI 3.x belgelerini tarayıcınızda tamamen TypeScript türlerine dönüştürün; yaygın openapi-typescript üretim seçenekleriyle.

OpenAPI belgesi
JSON veya YAML biçimindeki bir OpenAPI 3.0 ya da 3.1 belgesini yapıştırın, dosyadan içe aktarın veya CORS etkin bir URL'den alın.
TypeScript çıktısı
Oluşturulan TypeScript türleri, tarayıcıya uygun openapi-typescript hattı ve aşağıdaki seçeneklerle üretilir.
/**
 * 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>;
Üretim seçenekleri
Kaynak belgeyi değiştirmeden oluşturulan türleri ayarlayın.

OpenAPI’den TypeScript’e Dönüştürücü Nedir?

OpenAPI’den TypeScript’e Dönüştürücü, bir OpenAPI 3.x belgesini doğrudan tarayıcınızda oluşturulan TypeScript türlerine dönüştürür. Hızlı tür önizlemesi, indirilebilir bir bildirim dosyası veya şemanızı sunucuya göndermeden openapi-typescript seçeneklerini güvenle denemek istediğinizde kullanışlıdır.

Ne Zaman Kullanılır?

Bu aracı, elinizde JSON veya YAML biçiminde bir OpenAPI şeması olduğunda ve frontend uygulamalar, SDK prototipleri ya da API incelemeleri için tipli istek ve yanıt modelleri istediğinizde kullanın. Çıktıyı deponuza almadan önce üretim seçeneklerini karşılaştırmak için özellikle yararlıdır.

Üretmeden Önce

Bu tarayıcıya özel sürüm, paketlenmiş OpenAPI 3.0 ve 3.1 belgelerini destekler. Şemanızda hâlâ harici $ref hedefleri varsa, önce bunları paketleyin veya içe gömün, ardından son TypeScript çıktısını burada üretin.