ตัวแปลง OpenAPI เป็น TypeScript

แปลงเอกสาร OpenAPI 3.x เป็น TypeScript types ได้ทั้งหมดในเบราว์เซอร์ พร้อมตัวเลือกสร้างโค้ดแบบ openapi-typescript ที่ใช้บ่อย

เอกสาร OpenAPI
วางเอกสาร OpenAPI 3.0 หรือ 3.1 ในรูป JSON หรือ YAML นำเข้าจากไฟล์ หรือดึงจาก URL ที่เปิด CORS ได้
ผลลัพธ์ TypeScript
TypeScript types ที่สร้างขึ้นมาจะผ่านไปป์ไลน์ 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>;
ตัวเลือกการสร้าง
ปรับแต่ง types ที่สร้างขึ้นโดยไม่เปลี่ยนเอกสารต้นฉบับ

OpenAPI To TypeScript Converter คืออะไร?

OpenAPI to TypeScript Converter แปลงเอกสาร OpenAPI 3.x เป็น TypeScript types ที่สร้างขึ้นโดยตรงในเบราว์เซอร์ เหมาะเมื่อคุณต้องการพรีวิว type แบบรวดเร็ว ไฟล์ declaration ที่ดาวน์โหลดได้ หรือวิธีทดสอบตัวเลือก openapi-typescript อย่างปลอดภัยโดยไม่ต้องส่ง schema ไปยังเซิร์ฟเวอร์

ควรใช้เมื่อไร

ใช้เครื่องมือนี้เมื่อคุณมี OpenAPI schema ในรูป JSON หรือ YAML อยู่แล้ว และต้องการ request และ response models ที่มี type สำหรับแอป frontend, prototype ของ SDK หรือการตรวจทาน API เหมาะมากสำหรับเปรียบเทียบตัวเลือกการสร้างก่อนจะ commit ผลลัพธ์ลง repository

ก่อนสร้าง

เวอร์ชัน rewrite สำหรับเบราว์เซอร์นี้รองรับเอกสาร OpenAPI 3.0 และ 3.1 ที่ bundle แล้ว ถ้า schema ของคุณยังมี $ref ภายนอก ให้ bundle หรือ inline ก่อน แล้วค่อยสร้าง TypeScript output สุดท้ายที่นี่