參考 :http://www.ruanyifeng.com/blog/2014/05/restful_api.html
URL規劃
- 說明修改
| 修改內容 | 修改時間 | 修改人 |
|---|---|---|
| URL添加動作，單個Get，list默認分頁，find不分頁 | 2017-02-08 | 孫亮 |
命令規則：
- 1.小寫字母和”-”,不要大寫字母或其他RFC特殊字符,兩個單子之間使用”-”
- 2.按照資源從父級到底層的方式,從左向右
- 3.URL的動作在最后一個層級, 例如 /服務/資源/資源/動作
- 4.域名從左到右依次是:/服務/資源/資源/動作/首參數?次要參數=?&…
- 5.URL保持小寫一致，如果有文件時文件名小寫，使用”_”分割
- 6.edit、delete動作使用path傳值的方式(主鍵),其他參數攜帶在?之后
例如:/im/im-setting/auto-msg/edit/1?&token=token - 7.域名劃分:/服務/一級模塊/二級模塊/…/動作?參數
例如:/im/im-setting/auto-msg/edit/1?&token=token- 服務(一級路徑)：basic、auth、im、spirit、work-order、data
- 資源:
| 模塊名字 | 二級路徑 | 說明 |
|---|---|---|
| 訪客頁面 | visitor-index | |
| 設置 | setting | |
| 管理 | managemeng | |
| 精靈設置 | spirit-setting | |
| 工單設置 | work-order | |
| 幫助 | help |
表單提交方式
只使用GET和POST
- GET:查詢、刪除
- POST：新增、修改
URL動詞
說明:動詞在URL層級最后
| 動詞 | 說明 | HTTP動詞 |
|---|---|---|
| 動詞 | 說明 | HTTP動詞 |
| get | 單個 | GET |
| list | 分頁列表 | GET,POST |
| find | 不分頁 | GET,POST |
| create | 新增 | POST |
| update | 編輯 | GET-POST |
| delete | 刪除 | GET |
公共參數
| 參數名 | 說明 |
|---|---|
| page | 頁數 |
| pageSize | 每頁大小 |
| orderColumn | 排序字段 |
| dir | asc ,desc 排序方式 |
