Aller au contenu principal

Checklist API

Éléments à vérifier

  • Tous les fichiers API ont frontmatter et statut clair.
  • Les endpoints confirmés existent dans Laravel.
  • Les endpoints cibles sont explicitement marqués.
  • Les exemples sont génériques et non mensongers.
  • Les conventions /api/v1 sont appliquées.

Cohérence

  • API ↔ flows cohérents.
  • API ↔ modèles data cohérents.
  • API ↔ RBAC cohérents.
  • API ↔ ADR cohérents.

Sécurité

  • Middleware documenté par domaine.
  • Rate limiting mentionné pour endpoints sensibles.
  • Audit/logs mentionnés pour mutations sensibles.
  • Webhooks idempotents.

Dette documentaire

  • route-list.snapshot.json généré si audit exécuté.
  • Routes ambiguës classées à confirmer.
  • Payloads exacts à compléter après stabilisation.

Hypothèses

  • Route admin /api/v1/admin confirmée via route:list.
  • X-Device-Token comme header cible à confirmer.
  • API notifications/IA marquées cible si absentes.

Contradictions possibles

  • Code route vs commentaire.
  • Doc route confirmée mais code absent.
  • Middleware doc différent du code.

Éléments non confirmés

  • Formats de réponse finaux.
  • Codes erreurs stables.
  • Pagination standard.
  • Idempotency-Key réel.

Éléments critiques

  • Exécuter php artisan route:list.
  • Comparer toutes les routes confirmées.
  • Vérifier admin, webhooks, chat, IA, paiement.

Validations humaines nécessaires

  • Validation backend/API.
  • Validation sécurité.
  • Validation QA.