P
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 :**
```json
[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`.

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.

Learn more

Check the full skill on Prompt Guide to master this technique from A to Z.

View on Prompt Guide

📬 Get new prompts every week

Join our newsletter and never miss a prompt.