محول 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 إلى TypeScript مستند OpenAPI 3.x إلى أنواع TypeScript مولدة مباشرة في متصفحك. وهو مفيد عندما تريد معاينة سريعة للأنواع، أو ملف تعريف قابلًا للتنزيل، أو طريقة آمنة لاختبار خيارات openapi-typescript من دون إرسال schema إلى خادم.

متى تستخدمه

استخدم هذه الأداة عندما يكون لديك بالفعل schema OpenAPI بصيغة JSON أو YAML وتريد نماذج typed لطلباتك واستجاباتك لتطبيقات الواجهة الأمامية أو نماذج SDK أو مراجعات API. وهي مفيدة بشكل خاص لمقارنة خيارات التوليد قبل اعتماد الناتج في مستودعك.

قبل التوليد

تدعم هذه النسخة المعاد بناؤها للمتصفح مستندات OpenAPI 3.0 و3.1 المجمعة. إذا كان schema ما يزال يحتوي على أهداف $ref خارجية، فقم بضمها أو إدراجها أولًا، ثم ولّد مخرجات TypeScript النهائية هنا.