RESTful API 設計風格

HTTP經常使用動詞服務器

  • GET(SELECT):從服務器取出資源(一項或多項)。
  • POST(CREATE):在服務器新建一個資源。
  • PUT(UPDATE):在服務器更新資源(客戶端提供改變後的完整資源)。
  • PATCH(UPDATE):在服務器更新資源(客戶端提供改變的屬性)。
  • DELETE(DELETE):從服務器刪除資源

RESTful架構設計規範:架構

URL中最好不要出現動詞,儘可能使用名詞複數架構設計

URL中能夠帶版本號,也能夠在請求頭中攜帶版本號,但不如放入URL中直觀設計

過濾參數能夠放在查詢字符串中資源

針對不一樣操做,服務器返回不一樣的響應數據文檔

響應數據格式儘可能使用JSON字符串

響應狀態碼:1**(被接收,須要繼續處理),2**(請求成功),3**(請求重定向),4**(請求錯誤),5**(服務器錯誤)部署

應該儘可能將API部署在專用域名下,若是API很簡單,且不會有進一步擴展,能夠考慮放在主域名下域名

RESTful API最好作到Hypermedia(即返回結果中提供連接,指向其餘API方法),使得用戶不查文檔,也知道下一步應該作什麼。擴展

相關文章
相關標籤/搜索