- Maintenir la cohérence : URL/en-têtes/authentification/codes d’état..
- Utiliser le format de date ISO8601 en UTC
- N’exempter de l’authentification que les endpoints publics. Tous les autres doivent exiger une authentification
- Fournir un endpoint de vérification d’état
- Versionner l’API
- Mettre en place une authentification par clé API
- Utiliser des codes d’état et des méthodes HTTP pertinents
- Utiliser pour chaque endpoint un nom simple, explicite à lui seul
- Utiliser un format de réponse d’erreur standard
- Retourner la ressource créée par un POST
- Préférer PATCH à PUT
- Être aussi spécifique que possible
- Utiliser la pagination
- Rendre chaque ressource extensible (concevoir l’API pour pouvoir aussi renvoyer des informations supplémentaires via des paramètres de requête comme
expand)
2 commentaires
J’en ai beaucoup entendu parler ces derniers temps ici et là, et je recommande The Design of Web APIs by Arnaud Lauret. À cause du titre et de la couverture, on pourrait le prendre pour une sorte de livre de vulgarisation avec des analogies faciles sur Internet, mais c’est en réalité un très bon ouvrage qui met en lumière la finesse de l’auteur, dont le métier est précisément la conception d’API, sur le sujet du design d’API.
Les directives REST API de Microsoft
Les directives REST API de Stack Overflow