Comment concevoir une API REST avant de coder ?

1. Identifier les consommateurs

React ?

Flutter ?

Service externe ?

2. Identifier les besoins

Quelles opérations doivent-ils accomplir ?

3. Identifier les ressources

Clients, commandes, produits, etc.

4. Définir les opérations

Lecture, création, modification ou autres actions selon le modèle.

5. Définir les entrées

Quelles données sont attendues ?

6. Définir les réponses

Que reçoit le client ?

7. Définir les erreurs

Que se passe-t-il lorsque l’opération échoue ?

8. Sécuriser

Qui peut appeler quelle opération ?

9. Documenter

Le consommateur doit comprendre le contrat.

10. Tester

Cas normal, erreur et limite.

Exemple

Avant d’écrire `/orders`, décrivez :

qui crée une commande ?

quelles données ?

quelles règles ?

quelle réponse ?

quelles erreurs ?

C’est cela, concevoir avant de coder.