協(xié)議
restful api 應(yīng)該使用 https 協(xié)議
專用域名和版本
接口設(shè)計(jì)
| 操作 | 方法 | 接口 |
|---|---|---|
| 新增 | POST |
/users |
| 修改全部信息 | PUT |
/users/:id |
| 修改部分信息 | PATCH |
/users/:id |
| 刪除單條 | DELETE |
/users/:id |
| 刪除多條 | DELETE |
/usesr?ids=1001,1002,1003 |
| 查詢所有用戶 | GET |
/users |
| 查詢所有男性用戶 | GET |
/users?gender=1 |
| 查詢某個(gè)角色下的所有用戶 | GET |
/users?roleId=1 或 /roles/:id/users
|
| 查詢某個(gè)用戶 | GET |
/users/:id |
| 分頁查詢 | GET |
/users?page=1&rows=10 |
| 按字段排序 | GET |
/users?sortby=name&order=asc/desc |
復(fù)雜的查詢可以先 POST 一個(gè)查詢參數(shù)，接口返回一個(gè) queryId，然后通過這個(gè) queryId 去 GET
參考鏈接
http://www.ruanyifeng.com/blog/2014/05/restful_api.html
http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html
