REST API

咱們設計的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中規(guī)定URI區(qū)分大小寫,但別用大寫字母來為難程序員了,既不美觀,又麻煩
    負面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

最后,給后端研發(fā)工程師一個建議:清晰優(yōu)雅的 RESTful API是為調用者編寫的,別無腦隨意定義一些shit一樣的URI給移動/前端工程師使用,小心生命有危險。

原文:http://blog.restcase.com/7-rules-for-rest-api-uri-design/
作者:Guy Levin

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現,斷路器,智...
    卡卡羅2017閱讀 134,837評論 18 139
  • {"version":"2.5","action":"ImagesSetsListAction","errorCo...
    Sunney閱讀 642評論 0 0
  • 北京時間10月1日,2017-18賽季季前賽揭幕戰(zhàn)今天正式打響,金州勇士隊主場以102比108不敵勝丹佛掘金。不過...
    coco9981閱讀 396評論 0 2
  • 2016年即將過半,總該要總結下上半年的生活和工作吧,人生不就是不斷的反思、醒悟、改變后繼續(xù)前進嘛。 ...
    大可宋閱讀 334評論 0 0
  • 做一個好人。
    恐懼社交的金魚閱讀 145評論 0 0