参考 :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 排序方式 |
