咱们设计的REST API真的nice么?
- 咱们设计的REST API真的nice么?
- 优雅型:http://api.exapmle.com/louvre/da-vinci/mona-lisa
卢浮宫/达芬奇/蒙娜丽莎 - 中庸型:http://58.com/bj/ershou/310976
北京/二手频道/帖子ID - 谢特型:http://api.example.com/68dd0-a9d3-11e0-9f1c
不知道什么鬼
URI设计的一些原则。
URI的末尾不要添加“/”
多一个斜杠,语义完全不同,究竟是目录,还是资源,还是不确定而多做一次301跳转?
负面case:http://api.canvas.com/shapes/
正面case:http://api.canvas.com/shapes使用“-”提高URI的可读性
目的是使得URI便于理解,用“-”来连接单词
正面case:http://api.example.com/blogs/my-first-post禁止在URL中使用“”
目的是提高可读性,“”可能被文本查看器中的下划线特效遮蔽
负面case:http://api.example.com/blogs/my_first_post
别争,看到效果就明白了禁止使用大写字母
RFC 3986中规定URI区分大小写,但别用大写字母来为难程序员了,既不美观,又麻烦
负面case:http://api.example.com/My-Folder/My-Doc
正面case:http://api.example.com/my-folder/my-doc不要在URI中包含扩展名
应鼓励REST API客户端使用HTTP提供的格式选择机制Accept request header
正面case:http://58.com/bj/ershou/310976
一个case:http://58.com/bj/ershou/310976x.shtml建议URI中的名称使用复数
额,楼主不知道为何会有这么奇怪的建议
正面case:http://api.college.com/students/3248234/courses
负面case:http://api.college.com/student/3248234/course