ממיר 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 שנוצרים ישירות בדפדפן. הוא שימושי כשצריך תצוגה מקדימה מהירה של טיפוסים, קובץ declaration להורדה, או דרך בטוחה לבדוק אפשרויות של openapi-typescript בלי לשלוח את הסכימה לשרת.

מתי להשתמש בו

השתמשו בכלי הזה כשכבר יש לכם סכמת OpenAPI ב-JSON או YAML ואתם רוצים מודלים מטיפוסים לבקשות ולתשובות עבור אפליקציות frontend, אבות טיפוס ל-SDK, או סקירות API. הוא מועיל במיוחד להשוואת אפשרויות יצירה לפני ששומרים את הפלט בריפוזיטורי.

לפני היצירה

גרסת הכתיבה מחדש לדפדפן תומכת במסמכי OpenAPI 3.0 ו-3.1 מאוחדים. אם הסכמה עדיין מכילה יעדי $ref חיצוניים, יש לארוז או להטמיע אותם קודם, ואז ליצור כאן את פלט ה-TypeScript הסופי.