Bộ chuyển OpenAPI sang TypeScript

Chuyển tài liệu OpenAPI 3.x thành kiểu TypeScript ngay trong trình duyệt với các tùy chọn tạo openapi-typescript phổ biến.

Tài liệu OpenAPI
Dán tài liệu OpenAPI 3.0 hoặc 3.1 ở dạng JSON hay YAML, nhập từ tệp, hoặc lấy từ URL hỗ trợ CORS.
Kết quả TypeScript
Kiểu TypeScript được tạo ra bằng quy trình openapi-typescript an toàn trong trình duyệt và các tùy chọn bên dưới.
/**
 * 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>;
Tùy chọn tạo
Tinh chỉnh kiểu được tạo mà không thay đổi tài liệu nguồn.

OpenAPI To TypeScript Converter là gì?

OpenAPI to TypeScript Converter chuyển tài liệu OpenAPI 3.x thành kiểu TypeScript được tạo ra ngay trong trình duyệt. Công cụ này hữu ích khi bạn muốn xem nhanh kiểu sinh ra, tải về tệp khai báo, hoặc thử an toàn các tùy chọn openapi-typescript mà không cần gửi schema lên máy chủ.

Khi nào nên dùng

Dùng công cụ này khi bạn đã có schema OpenAPI ở JSON hoặc YAML và muốn có model request và response có kiểu cho ứng dụng frontend, bản thử SDK, hoặc rà soát API. Nó đặc biệt hữu ích khi so sánh các tùy chọn tạo trước khi bạn đưa kết quả vào kho mã nguồn.

Trước khi tạo

Bản chuyển sang trình duyệt này hỗ trợ tài liệu OpenAPI 3.0 và 3.1 đã được bundle. Nếu schema của bạn vẫn còn các đích $ref bên ngoài, hãy bundle hoặc inline chúng trước, rồi tạo đầu ra TypeScript cuối cùng tại đây.