Convertisseur OpenAPI vers TypeScript

Convertissez des documents OpenAPI 3.x en types TypeScript directement dans votre navigateur, avec des options courantes de génération openapi-typescript.

Document OpenAPI
Collez un document OpenAPI 3.0 ou 3.1 en JSON ou YAML, importez-le depuis un fichier, ou récupérez-le depuis une URL compatible CORS.
Sortie TypeScript
Les types TypeScript générés sont produits via une chaîne openapi-typescript compatible navigateur et les options ci-dessous.
/**
 * 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 de génération
Ajustez les types générés sans modifier le document source.

Qu’est-ce que le convertisseur OpenAPI vers TypeScript ?

OpenAPI to TypeScript Converter transforme un document OpenAPI 3.x en types TypeScript générés directement dans votre navigateur. C’est utile pour obtenir rapidement un aperçu des types, télécharger un fichier de déclaration ou tester en toute sécurité les options openapi-typescript sans envoyer votre schéma à un serveur.

Quand l’utiliser

Utilisez cet outil si vous avez déjà un schéma OpenAPI en JSON ou YAML et que vous voulez des modèles typés de requêtes et de réponses pour des applications frontend, des prototypes de SDK ou des revues d’API. Il est particulièrement utile pour comparer les options de génération avant de valider la sortie dans votre dépôt.

Avant de générer

Cette version pour navigateur prend en charge les documents OpenAPI 3.0 et 3.1 regroupés. Si votre schéma contient encore des cibles $ref externes, regroupez-les ou intégrez-les d’abord, puis générez ici la sortie TypeScript finale.