API publique¶
Client¶
| Méthode | Usage | Notes |
|---|---|---|
get<T>(path, options?) |
Lecture typée. | Compatible cache et query. |
post<T>(path, options?) |
Création ou commande. | Utiliser json et idempotencyKey quand l'opération est rejouable. |
put<T>(path, options?) |
Remplacement. | Préférer If-Match si le backend supporte l'optimistic locking. |
patch<T>(path, options?) |
Mise à jour partielle. | Payload minimal et schéma runtime pour payloads critiques. |
delete<T>(path, options?) |
Suppression. | Attention aux retries automatiques sans idempotence. |
Parsers¶
| Parseur | Usage | Notes |
|---|---|---|
createApiParserRestClassic |
Enveloppe REST classique. | Adapte data, message, errors. |
createApiParserLaravel |
Erreurs de validation Laravel. | Normalise issues et messages. |
createApiParserNest |
Réponses et exceptions NestJS. | Bon choix pour backends TypeScript. |
createApiParserGraphQL |
Payload data/errors. |
allowPartialData conserve une réponse partielle. |
createApiParserStructured |
Enveloppes avec méta. | Expose catégorie, sévérité, retryable, i18n, traceId, spanId. |
createShapeParser |
Enveloppes propriétaires. | À privilégier quand aucun preset ne colle au backend. |
Guards¶
| Guard | Usage | Notes |
|---|---|---|
retryGuard |
Relance configurable. | Limiter aux erreurs transitoires et documenter les exclusions. |
bearerRefreshGuard |
Refresh token Bearer single-flight. | Protège les 401 concurrents. |
cookieSafeRefreshGuard |
Refresh session cookie. | Single-flight, cooldown 429, anti-loop. |
csrfGuard |
Token CSRF sur mutations. | Lit cookie, storage ou header. |
correlationIdGuard |
Correlation id request/response. | Alimente logger, Sentry et OTel. |
idempotencyGuard |
Header idempotence sur mutations. | Respecte une clé existante. |
unauthorizedGuard |
Hook central sur 401/403. | Logout, redirection ou invalidation session. |
instrumentGuard |
Mesure et instrumentation custom. | Encapsule timing ou reporting maison. |