Skip to main content
Lors de l’intégration avec des services externes, il est crucial de définir des types TypeScript qui reflètent fidèlement les structures de données des API. Cela garantit une interaction fluide et réduit les erreurs potentielles.

​
Processus de Définition des Types

1

Comprendre l'API de l'Intégration

  1. Consulter la Documentation
• Explorez la documentation officielle de l’API de l’intégration (par exemple, Hubrise)• Identifiez les endpoints que vous allez utiliser et les structures de données qu’ils renvoient ou acceptent
  1. Identifier les Types de Données
• Notez les types de données que chaque endpoint renvoie ou accepte• Identifiez les objets, tableaux, chaînes de caractères, nombres, etc.
2

Définir les Types en TypeScript

  1. Créer des Interfaces
• Pour chaque type de données identifié, créez une interface TypeScript• Structurez les données de manière cohérente avec l’API
  1. Gérer les Champs Optionnels
• Marquez les champs optionnels avec ?• Évitez les erreurs lorsque l’API ne renvoie pas certaines données
  1. Vérifier les Noms de Propriétés
• Assurez-vous que les noms correspondent exactement à ceux de l’API

​
Exemple avec Hubrise

1

Documentation Hubrise

• Endpoint : /orders• Réponse :
{
  "id": "123",
  "status": "new",
  "items": [
    {
      "id": "item-1",
      "name": "Pizza",
      "quantity": 2
    }
  ],
  "customer": {
    "id": "cust-1",
    "name": "John Doe"
  }
}
2

Définition des Types

interface HubriseItem {
  id: string;
  name: string;
  quantity: number;
}

interface HubriseCustomer {
  id: string;
  name: string;
}

interface HubriseOrder {
  id: string;
  status: string;
  items: HubriseItem[];
  customer?: HubriseCustomer; // Champ optionnel
}

​
Bonnes Pratiques

1

Champs Optionnels

• Ne pas oublier de marquer les champs optionnels
2

Types Précis

• Utilisez les types les plus précis possibles
3

Consistance des Noms

• Assurez-vous que les noms de propriétés correspondent exactement à ceux de l’API
En suivant ce guide, vous pouvez créer des types TypeScript qui reflètent fidèlement les structures de données des API externes, facilitant ainsi l’intégration et réduisant les erreurs potentielles lors de l’interaction avec les services tiers.