P
IntermediaireChatGPT

Générer des types TypeScript depuis une réponse API

Génère des types TypeScript stricts depuis une réponse JSON : interfaces, types utilitaires, guards de type, enums et documentation JSDoc.

Coller dans votre IA

Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.

Tu es un expert TypeScript. Génère des types TypeScript complets et bien structurés pour le contrat d'API suivant.

Source de l'API : [SOURCE_API] (ex: API REST interne, API GitHub, Stripe)
Réponse JSON exemple :

[REPONSE_JSON]

Endpoints concernés : [ENDPOINTS]

Génère :

  1. Types de base : interfaces et types pour toutes les entités
  2. Types utilitaires : Partial, Pick, Omit dérivés pour les cas courants (création, mise à jour)
  3. Types de réponse API : enveloppes génériques (ApiResponse<T>, PaginatedResponse<T>)
  4. Types d'erreur : structure des erreurs API typée
  5. Type Guards : fonctions isXxx() pour validation runtime
  6. Enums : pour les champs avec valeurs définies
  7. JSDoc : documentation de chaque interface et champ important
  8. Exemple d'utilisation : comment utiliser ces types dans un composant ou service

Priorité : précision des types > commodité. Évite les any.

Personnaliser ce prompt avec Léa

Réponds à 3 questions, Léa adapte le prompt à ta situation.

Pourquoi ce prompt fonctionne

La règle 'précision > commodité' et l'interdiction de `any` cadrent l'IA sur la production de types réellement utiles. Les type guards résolvent le problème de la validation runtime souvent ignorée. Les types utilitaires dérivés (création/mise à jour) reflètent les besoins réels des formulaires et mutations.

Cas d'usage

Typer une intégration avec une API tierceMaintenir les types synchronisés avec l'API backendPréparer un SDK TypeScript pour une API

Résultat attendu

Interfaces TypeScript complètes, types utilitaires dérivés, types de réponse génériques, type guards, enums, documentation JSDoc et exemple d'utilisation.

Améliorez ce prompt

Passez ce prompt dans l'Optimiseur pour renforcer le contexte, les contraintes et le format attendu.

Améliore ce prompt avec l'Optimiseur

Commentaires

  • LéaIA

    Pour des APIs volumineuses, préférez générer ces types depuis un schéma OpenAPI (ex: `openapi-typescript`) plutôt que d’un seul exemple JSON. Cela couvre tous les cas et évite les incohérences. Si vous devez rester sur un exemple, combinez ce prompt avec des unions discriminées pour les statuts de réponse.

📬 Recevez de nouveaux prompts chaque semaine

Rejoignez notre newsletter et ne manquez aucun prompt.

Pour aller plus loin