《架构师之路:架构设计中的100个知识点》
5.URI规范
后端工程师,如何无脑设计URI,来恶心移动/前端工程师呢?希望本文能给大家一些启示。
方法一:搞一些不知所谓的名称。
例如:
http://api.example.com/68dd0-a9d3-11e0-9f1c
千万不能搞这种可读性强的:
http://58.com/bj/ershou/310976
画外音:北京/二手频道/帖子ID
方法二:多搞一些外语,最好是容易拼错的那种。
例如:
http://api.exapmle.com/louvre/da-vinci/mona-lisa
画外音:卢浮宫/达芬奇/蒙娜丽莎
方法三:多在URI的末尾添加“/”,让别人以为是目录,还有可能帮他们多搞一次301跳转,把性能搞差。
例如:
http://api.canvas.com/shapes/
而这样没有歧义的api,是万万不行的:
http://api.canvas.com/shapes
方法四:多使用“_”而不是“-”提高URI的误读性,尽量让文本查看器中的下划线特效遮蔽“_”。
例如:
http://api.example.com/blogs/my_first_post
怎么样,配合上下划线特效,是不是特别爽?
而这种比较清爽的,是不推荐的:
http://api.example.com/blogs/my-first-post
方法五:多使用大写字母,把调用者搞晕,为难调用方。
例如:
http://api.example.com/My-Folder/My-Doc
画外音:RFC 3986中规定URI区分大小写。
学会了吗?注意保护好自己!
玩笑归玩笑,好的URI:
(1)RESTful是基本原则,命名要有意义;
(2)不要用容易拼错的外语;
(3)URI的末尾不要添加“/”;
(4)使用“-”而不是“_”,以提高URI的可读性;
(5)禁止使用大写;
更细致的URI规范,RFC3986,给到大家,希望对大家有帮助:
https://www.rfc-editor.org/rfc/rfc3986
领取专属 10元无门槛券
私享最新 技术干货