OpenAPI से TypeScript कन्वर्टर

ब्राउज़र में OpenAPI 3.x दस्तावेज़ों को TypeScript प्रकारों में बदलें, common openapi-typescript generation options के साथ।

OpenAPI दस्तावेज़
JSON या YAML में OpenAPI 3.0 या 3.1 दस्तावेज़ पेस्ट करें, फ़ाइल से इम्पोर्ट करें, या CORS-enabled URL से फ़ेच करें।
TypeScript आउटपुट
जनरेट किए गए TypeScript types browser-safe openapi-typescript pipeline और नीचे दिए गए options से बनते हैं।
/**
 * 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>;
जनरेशन options
source document बदले बिना generated types को fine-tune करें।

OpenAPI To TypeScript Converter क्या है?

OpenAPI to TypeScript Converter एक OpenAPI 3.x दस्तावेज़ को सीधे आपके browser में generated TypeScript types में बदलता है। यह तब उपयोगी है जब आपको तेज़ type preview, डाउनलोड करने योग्य declaration file, या openapi-typescript options को server पर schema भेजे बिना आज़माने का सुरक्षित तरीका चाहिए।

इसे कब इस्तेमाल करें

इस tool का उपयोग तब करें जब आपके पास JSON या YAML में OpenAPI schema पहले से हो और आपको frontend apps, SDK prototypes, या API reviews के लिए typed request और response models चाहिए हों। Output को repository में commit करने से पहले generation options compare करने में यह खास तौर पर मदद करता है।

जनरेट करने से पहले

यह browser rewrite bundled OpenAPI 3.0 और 3.1 documents को support करता है। अगर आपके schema में अभी भी external $ref targets हैं, तो पहले उन्हें bundle या inline करें, फिर final TypeScript output यहाँ जनरेट करें।