Guide de Conception d'API: Construire des APIs que vos Utilisateurs Aimeront

Une API mal conçue est un impôt sur chaque développeur qui l'utilise. Une API bien conçue se sent naturelle et s'adapte sans se casser.

Principes de l'API REST

1. Utilisez les Noms, Pas les Verbes

Mauvais:

```

GET /api/getUsers

POST /api/createUser

DELETE /api/deleteUserById?id=123

```

Bon:

```

GET /api/users

POST /api/users

DELETE /api/users/123

```

2. Les Codes de Statut HTTP Comptent

N'utilisez pas 200 pour tout:

```

200 OK → La requête a réussi

201 Created → La ressource a été créée

204 No Content → Succès, pas de corps de réponse

400 Bad Request → Erreur client

401 Unauthorized → L'authentification est requise

403 Forbidden → Authentifié mais non autorisé

404 Not Found → La ressource n'existe pas

500 Server Error → Quelque chose s'est cassé de notre côté

```

3. Format de Réponse Cohérent

Chaque réponse doit suivre la même structure:

```json

{

"success": true,

"data": { "id": 123, "name": "Jean" }

}

```

4. Pagination pour les Listes

Ne renvoyez jamais des millions de dossiers à la fois:

```

GET /api/users?page=1&limit=50

```

5. Filtrage et Tri

Permettez aux clients de spécifier les données qu'ils veulent:

```

GET /api/users?status=active&sort=created_at:desc

```

Conclusion

Une API bien conçue s'adapte et se sent naturelle. Nous construisons d'excellentes APIs chez mznah.