[TOC]
## 列表
* 请求地址: `/banner`
* 请求方式: get
* 请求参数: 无
* 成功返回:
```json
{
"code": 0,
"data": {
"data": [],
"currentPage": 1,
"pageNumber": 10,
"count": 0
}
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 分页
* 请求地址: `/banner/pag`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `currentPage` | int | 11 | `是` | 当前页 |
| `pageNumber` | int | 11 | `是` | 页码 |
* 成功返回:
```json
{
"code": 0,
"data": {
"data": []
}
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 搜索
* 请求地址: `/banner/search`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `search` | string | 2-200 | `是` | 搜索内容(标题) |
* 成功返回:
```json
{
"code": 0,
"data": {
"data": []
}
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 新增查询(获取图片上传路径)
* 请求地址: `/banner/read`
* 请求方式: get
* 请求参数:无
* 成功返回:
```json
{
"oss_id": "",//上传参数
"host": "",//上传地址
"policy": "",//上传参数
"signature": "",//上传参数
"expire": 1514861903,//上传时间
"dir": "banner",//上传的文件夹
"max_size": 10485760//文件大小
}
```
>[info] 上传参数
```json
"OSSAccessKeyId": "oss_id",
"policy": "policy",
"Signature": "signature",
"key":"key",
"success_action_status":"201",
"file":"raw file data"
```
>[info] 提交地址为返回参数中的host
>[danger] 注:上传方式 需要使用表单 `FormData` 格式上传
>注:返回的上传参数中若有key,必须使用返回的key,如果没有,就需要使用返回的 `dir+/filename` 的格式拼接文件名
>注:`filename` 是自己定义的文件名
>注: file字段**必须在最后**,类型根据平台不同而不同,兼容 `FormData`即可
>注:上传成功之后会返回一个xml格式的文件,请解析xml文件 。
>注:取出xml文件的 location 当做图片或者视频地址 提交到服务器
>注:上传图片请自定义文件名
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 新增保存
* 请求地址: `/banner/save`
* 请求方式: post
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `title` | string | 2-32 | `是` | 标题 |
| `img` | string | 2-160 | `是` | 图片地址 |
| `url` | string | 2-160 | `是` | 连接地址 |
| `order` | int | 11 | `是` | 前端排序 |
| `show` | int | 11 | `是` | 是否在前端显示 |
* 成功返回:
```json
{
"code": 0
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 修改查询
* 请求地址: `/banner/edit`
* 请求方式: get
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
* 成功返回:
```json
{
"code": 0,
"data": {
"data": []
}
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 修改保存
* 请求地址: `/banner/update`
* 请求方式: post
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
| `title` | string | 2-32 | `是` | 标题 |
| `img` | string | 2-160 | `是` | 图片地址 |
| `url` | string | 2-160 | `是` | 连接地址 |
| `order` | int | 11 | `是` | 前端排序 |
| `show` | int | 11 | `是` | 是否在前端显示 |
* 成功返回:
```json
{
"code": 0
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
## 删除
* 请求地址: `/banner/delete`
* 请求方式: post
* 请求参数:
| 字段名 | 字段类型 | 字段长度 | 必填 | 字段说明 |
| --- | --- | --- | --- | --- |
| `id` | int | 11 | `是` | id |
* 成功返回:
```json
{
"code": 0
}
```
* 失败返回:
```json
{
"code": -1,
"msg": "参数错误!"
}
```
- 使用须知
- 登录相关
- 共用数据
- 个人相关
- 管理相关
- 管理角色
- 常见问题
- 生活缴费
- 缴费订单
- 面积区间
- 租金区间
- 户型管理
- 配套设施
- 长租周期
- 短租周期
- 支付方式
- banner
- 区域管理
- 省
- 市
- 区(县)
- 地标
- 门店
- 内部门店
- 外部门店
- 处理门店申请
- 销售
- 小区
- 物业公司
- 物业人员
- 申请提现
- 奖励设置
- 奖励金列表
- 地铁管理
- 地铁线路
- 地铁站点
- 配置信息
- 内部长租
- 内部短租
- 外部长租
- 外部短租
- 前端用户
- 提现申请
- 站内信
- 房源委托
- 房源信息
- 房源统计
- 电子锁
- 申请看房
- 租房订单
- 第三方
- 第三方门店
- 第三方销售
- 财务管理
- 内部店长模块
- 登录注册
- 内部门店相关
- 店长下的销售
- 内部提现记录
- 第三方店长模块
- 登录注册(三方)
- 门店统计(三方)
- 销售列表(三方)
- 提现记录(三方)
- 操作记录