REST API

作者: codingJanson | 来源:发表于2019-07-12 09:56 被阅读0次

咱们设计的REST API真的nice么?

URI设计的一些原则。

  1. URI的末尾不要添加“/”
    多一个斜杠,语义完全不同,究竟是目录,还是资源,还是不确定而多做一次301跳转?
    负面case:http://api.canvas.com/shapes/
    正面case:http://api.canvas.com/shapes

  2. 使用“-”提高URI的可读性
    目的是使得URI便于理解,用“-”来连接单词
    正面case:http://api.example.com/blogs/my-first-post

  3. 禁止在URL中使用“
    目的是提高可读性,“
    ”可能被文本查看器中的下划线特效遮蔽
    负面case:http://api.example.com/blogs/my_first_post
    别争,看到效果就明白了

  4. 禁止使用大写字母
    RFC 3986中规定URI区分大小写,但别用大写字母来为难程序员了,既不美观,又麻烦
    负面case:http://api.example.com/My-Folder/My-Doc
    正面case:http://api.example.com/my-folder/my-doc

  5. 不要在URI中包含扩展名
    应鼓励REST API客户端使用HTTP提供的格式选择机制Accept request header
    正面case:http://58.com/bj/ershou/310976
    一个case:http://58.com/bj/ershou/310976x.shtml

  6. 建议URI中的名称使用复数
    额,楼主不知道为何会有这么奇怪的建议
    正面case:http://api.college.com/students/3248234/courses
    负面case:http://api.college.com/student/3248234/course

相关文章

网友评论

      本文标题:REST API

      本文链接:https://www.haomeiwen.com/subject/sxnskctx.html