Actuellement, Internet regorge d'un grand nombre d'articles sur la façon de concevoir une API RESTful (pour plus de commodité, « API RESTful » est abrégé ci-dessous en « API ». Cependant, il n'existe pas de norme de conception « universelle » : comment s'authentifier). ? Quel est le format de l'API ? Lorsque vous commencez à écrire une application, en particulier lorsque la partie modèle back-end a été écrite, vous devez faire de grands efforts pour concevoir et implémenter la partie API publique de votre application. Car une fois publiée, l’API diffusée vers le monde extérieur sera difficile à modifier.
Question 1 :
Envoyer un e-mail /mail/1/send en utilisant POST /mail/send en utilisant POST
Comment nommer l'URL
Question 2
Obtenir une liste d'utilisateurs spécifique /getVipUser /user/vip /getUserList?type=vip
Comment nommer l'URL
Question 3
Dois-je utiliser la forme de la bosse ou du serpent ? Je suis très confus. J'ai utilisé les deux. Certaines personnes disent que cela n'a pas d'importance, mais je suis confus.
Restful n'est qu'un ensemble de spécifications de référence. Je crois comprendre qu'il n'y a pas de spécification unique dans le domaine du développement logiciel, seulement différentes bonnes pratiques. Quant à l'API, elle doit simplement être simple pour les développeurs. pour distinguer. Vous n'avez pas à vous forcer à le faire pour des raisons de spécifications, tant que la fonction est implémentée, peu importe à quoi ressemble votre API.
Vous pouvez consulter le blog de Ruanyifeng :
http://www.ruanyifeng.com/blo...
Concernant l'utilisation d'un étui chameau ou d'un étui serpent, tout doit être en minuscules
vip
可以作为一个资源GET vips/user/{id}
ORGET users/vip/{id}
获取单个资源GET vips/user
ORGET users/vip
Obtenez plusieurs ressourcesVous souhaiterez peut-être vous référer à ces ressources : restful-api-design-references - Liste de référence de conception d'API RESTful, qui peut vous aider à mieux comprendre la conception d'interface de style REST.
Dans l'application pratique de l'API RESTful, la conception de l'API Github v3 peut être considérée comme un modèle, vous pouvez également y jeter un œil.