Parcourez la documentation
Haomai Technology AI Brain

Valider un exemple de projet et de client

Établissez une base de test reproductible à l’aide de données synthétiques avant d’intégrer de vrais appels API. Cela permet de distinguer plus facilement les erreurs de traitement des données, les erreurs de protocole et les erreurs de présentation.

Guide technique · Novembre 20265 min de lecture

Ce qui appartient à un exemple de projet

Gardez la configuration, les appels API, la validation des résultats et la présentation séparés. Fournissez des adresses et des informations d’identification via la configuration de l’environnement et spécifiez les versions de dépendance et d’exécution. Affichez les résultats réussis et échoués afin que les utilisateurs puissent évaluer à la fois l’exécution et l’exactitude de l’entreprise.

Si votre version inclut un SDK officiel, suivez ses instructions d’installation et d’authentification spécifiques à la version. Sinon, écrivez au client contre le contrat API convenu. Confirmez les noms des packages auprès du fournisseur et conservez les informations d’identification personnelles hors du référentiel.

Commencez par un exemple synthétique entièrement local

L’exemple de bibliothèque standard Python ci-dessous filtre par statut, puis totalise les lignes sélectionnées. Il s’exécute localement sans appeler Haomai Technology AI Brain ni se connecter à une base de données. Utilisez-le comme point de départ pour tester une définition de métrique. Le total attendu est 200.00.

Python
from decimal import Decimal

# Synthetic records for a local calculation. No SDK call is made.
orders = [
    {"region": "A", "status": "confirmed", "amount": "120.00"},
    {"region": "B", "status": "confirmed", "amount": "80.00"},
    {"region": "A", "status": "cancelled", "amount": "30.00"},
]
total = sum(
    (Decimal(row["amount"]) for row in orders
     if row["status"] == "confirmed"),
    Decimal("0.00"),
)
assert total == Decimal("200.00")
print(total)

Ajouter l’appel de service

  1. Conservez les données de référence locales et les résultats attendus afin que le calcul puisse être effectué de manière indépendante.
  2. Implémentez l’appel conformément au contrat réel et configurez les délais d’attente et l’annulation dans l’environnement de test.
  3. Convertissez les valeurs renvoyées en une structure de données explicite qui distingue les résultats terminés, échoués et partiels.
  4. Vérifiez que les journaux omettent les informations d’identification, les questions privées complètes et les détails inutiles au niveau de l’enregistrement.

Inclure les cas d’échec dans l’exemple

Couvrez au minimum les résultats vides, les incohérences de type, les champs inconnus, les délais d’attente et les autorisations insuffisantes. Donnez aux utilisateurs une prochaine étape de diagnostic parallèlement à l’erreur. Réexécutez ces cas après les mises à niveau des dépendances ou des services pour identifier la couche qui a changé.

Incluez les cas limites pour les montants, les valeurs manquantes et les champs de statut. Distinguer une valeur manquante d’un zéro numérique. Le fait de combler automatiquement les lacunes de l’affichage peut masquer un problème de qualité des données ou un changement de protocole.

Essayez « autorisations », « source de données », « fabrication » ou « API ».