OpenAPI naar TypeScript-converter

Zet OpenAPI 3.x-documenten rechtstreeks in je browser om naar TypeScript-types met gangbare openapi-typescript-generatieopties.

OpenAPI-document
Plak een OpenAPI 3.0- of 3.1-document in JSON of YAML, importeer het uit een bestand of haal het op vanaf een CORS-ingeschakelde URL.
TypeScript-uitvoer
De gegenereerde TypeScript-types worden gemaakt met een browserveilige openapi-typescript-pijplijn en de onderstaande opties.
/**
 * 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>;
Generatie-opties
Stem de gegenereerde types af zonder het brondocument te wijzigen.

Wat is OpenAPI to TypeScript Converter?

OpenAPI to TypeScript Converter zet een OpenAPI 3.x-document rechtstreeks in je browser om naar gegenereerde TypeScript-types. Het is handig wanneer je snel een typevoorbeeld wilt zien, een downloadbaar declaration-bestand nodig hebt of veilig openapi-typescript-opties wilt testen zonder je schema naar een server te sturen.

Wanneer Gebruik Je Het

Gebruik deze tool wanneer je al een OpenAPI-schema in JSON of YAML hebt en getypeerde request- en responsemodellen wilt voor frontend-apps, SDK-prototypes of API-reviews. Het is vooral handig om generatieopties te vergelijken voordat je de uitvoer vastlegt in je repository.

Voor Je Genereert

Deze browser-variant ondersteunt gebundelde OpenAPI 3.0- en 3.1-documenten. Als je schema nog externe $ref-doelen bevat, bundel of inline die dan eerst en genereer daarna hier de definitieve TypeScript-uitvoer.