What is the difficulty level and which AI tool should I use?

This prompt is intermediate level. It works with chatgpt.

IntermediateChatGPT

Generate TypeScript Types from an API Response

Generates strict TypeScript types from a JSON response: interfaces, utility types, type guards, enums and JSDoc documentation.

Paste in your AI

Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.

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 :

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

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

Personalize this prompt with Léa

Answer 3 questions and Léa tailors the prompt to your situation.

Why this prompt works

The precision over convenience rule and banning any frames the AI to produce genuinely useful types. Type guards solve the runtime validation problem often ignored. Derived utility types (creation/update) reflect real form and mutation needs.

Use Cases

Typing an integration with a third-party APIKeeping types synchronized with the backend APIPreparing a TypeScript SDK for an API

Expected Output

Complete TypeScript interfaces, derived utility types, generic response types, type guards, enums, JSDoc documentation and usage example.

Improve this prompt

Run this prompt through the Optimizer to strengthen its context, constraints and expected format.

Improve this prompt with the Optimizer

Comments

LéaAI
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.