RESTful在路由url有名義的寫法

WaitMoonMan發表於2018-04-05
  • 前邊已經有過一篇部落格簡單的介紹在Laravel 中使用 RESTful
  • 這篇文章介紹一下各種RESUful風格路由的寫法,不一定是正確,但是個人覺得寫這樣的路由很有含義。

基礎路由

  • 一般放在一個組裡,其他路由總要帶上這個字首
    • 總是api**+**版本號
    • /api/v1

基本引數

  • 分頁的引數,直接使用QueryString
    • limit
    • page
    • /url?limit=10&page=1
  • 多引數排序
    • /url?desc=created_at,id&asc=grade,updated_at

基本的路由

  • 分類列表
    • method: get
    • /categories
  • 建立分類
    • method: post
    • /categories
  • 刪除分類
    • method: delete
    • /categories/{category}
  • 單個分類
    • method: get
    • /catagories/{catagory}
  • 修改分類
    • method: put
    • /categories/{category}

稍微複雜的路由

  • 獲取分類下的所有文章
    • method: get
    • /categories/{category}/articles
  • 獲取標籤下的所有文章
    • method: get
    • /tags/{tag}/articles
  • 批量刪除文章 (儘量不要進行批量操作)
    • method: delete
    • /article/batch?id=1,2,3

認證的路由

  • 通常情況下都可以使用(名義明確的)
  • 登入
    • method: post
    • /login
  • 登出
    • method: post
    • /logout
  • 但是為了符合RESTful風格,我們也可以換個名字
  • 登入 (實際上就是建立一個 token)
    • method: post
    • /tokens
  • 登出 (實際上就是刪除 token)
    • method: delete
    • /tokens/{token}

長名字路由

  • 有時候總不可避免的出現路由名字多個單片語合
    • 這時候我們可以使用中劃線分隔,更利於seo優化
    • 獲取某種文章型別的文章
    • method: get
    • /article-types/{article_type}/articles

相關文章