咱們設(shè)計的REST API真的nice么？
優(yōu)雅型：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設(shè)計的一些原則。
1. URI的末尾不要添加“/”
多一個斜杠，語義完全不同，究竟是目錄，還是資源，還是不確定而多做一次301跳轉(zhuǎn)？
負面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中規(guī)定URI區(qū)分大小寫，但別用大寫字母來為難程序員了，既不美觀，又麻煩
負面case：http://api.example.com/My-Folder/My-Doc
正面case：http://api.example.com/my-folder/my-doc
5. 不要在URI中包含擴展名
應(yīng)鼓勵REST API客戶端使用HTTP提供的格式選擇機制Accept request header
正面case：http://58.com/bj/ershou/310976
一個case：http://58.com/bj/ershou/310976x.shtml
6. 建議URI中的名稱使用復(fù)數(shù)
額，樓主不知道為何會有這么奇怪的建議
正面case：http://api.college.com/students/3248234/courses
負面case：http://api.college.com/student/3248234/course
