RESTful API 设计最佳实践

文章预览

编者按：本文由slane在众成翻译平台上翻译。 项目资源的URL应该如何设计？用名词复数还是用名词单数？一个资源需要多少个URL？用哪种HTTP方法来创建一个新的资源？可选参数应该放在哪里？那些不涉及资源操作的URL呢？实现分页和版本控制的最好方法是什么？太多的可能性使得RESTful API的设计变得很棘手。在这篇文章中，我们来看一下RESTful API设计，并给出一个最佳实践方案。 每个资源使用两个URL 资源集合用一个URL，具体某个资源用一个URL： / employees #资源集合的URL / employees / 56  #具体某个资源的URL 用名词代替动词表示资源 这让你的API更简洁，URL数目更少。不要这么设计： / getAllEmployees / getAllExternalEmployees / createEmployee / updateEmployee 更好的设计： GET  / employees ………………………………