添加广告接口文档

This commit is contained in:
pengtao 2019-07-09 19:37:04 +08:00
parent 8ccd20fc1d
commit c682160492

220
README.MD
View File

@ -16,7 +16,7 @@ http://192.168.100.20:8888/company?status=0
##### 请求参数说明 ##### 请求参数说明
| 名称 | 类型 | 必填 | | | 名称 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---------------------------------- | | ------ | ---- | ---- | ---------------------------------- |
| status | int | 否 | 0=未审批1=审批通过2=审批未通过 | | status | int | 否 | 0=未审批1=审批通过2=审批未通过 |
| id | int | 否 | 返回该id对应公司信息 | | id | int | 否 | 返回该id对应公司信息 |
@ -75,7 +75,7 @@ http://192.168.100.20:8888/company?name=kings&contact=pt&tel=1234
##### 请求参数说明 ##### 请求参数说明
| 名称 | 类型 | 必填 | | | 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------- | | ------- | ------ | ---- | -------- |
| name | string | 是 | 公司名称 | | name | string | 是 | 公司名称 |
| contact | string | 是 | 联系人 | | contact | string | 是 | 联系人 |
@ -110,7 +110,7 @@ http://192.168.100.20:8888/company?appid=zpoHY37u&appkey=undefined&contact=miles
##### 请求参数说明 ##### 请求参数说明
| 名称 | 类型 | 必填 | | | 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------- | | ------- | ------ | ---- | -------------- |
| name | string | 是 | 公司名称 | | name | string | 是 | 公司名称 |
| contact | string | 是 | 联系人 | | contact | string | 是 | 联系人 |
@ -149,7 +149,7 @@ http://192.168.100.20:8888/company?id=1006
##### 请求参数说明 ##### 请求参数说明
| 名称 | 类型 | 必填 | | | 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- | | ---- | ---- | ---- | -------------- |
| id | int | 是 | 公司id(唯一值) | | id | int | 是 | 公司id(唯一值) |
@ -166,7 +166,7 @@ http://192.168.100.20:8888/company?id=1006
"code": 200 "code": 200
} }
#### 5、添加位置服务信息 #### 5、返回位置服务信息
##### 接口地址 ##### 接口地址
@ -182,8 +182,146 @@ http://192.168.100.20:8888/location
##### 请求参数说明 ##### 请求参数说明
| 名称 | 类型 | 必填 | | | 名称 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ------ |
| gameid | int | 是 | 游戏ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ------- | ---- | ---- | ------------ |
| code | int | 是 | 返回状态 |
| message | json | 是 | 所有位置信息 |
##### 返回示例
{
"code": 200
}
#### 6、添加位置服务信息
##### 接口地址
http://192.168.100.20:8888/location
##### 返回格式json
##### 请求方式post
##### 请求示范
http://192.168.100.20:8888/location
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | ---------------------------------------- |
| area | int | 是 | 区域(1=首页2=游戏中3=结算页4=关闭) |
| type | int | 是 | 类型1=icon2=banner3=浮窗) |
| | int | 是 | 游戏ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 7、删除位置服务信息
##### 接口地址
http://192.168.100.20:8888/location
##### 返回格式json
##### 请求方式delete
##### 请求示范
http://192.168.100.20:8888/location
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- |
| id | int | 是 | 需删除的位置ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 8、添加广告信息
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式json
##### 请求方式post
##### 请求示范
http://192.168.100.20:8888/ad
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- |
| id | int | 是 | 需删除的位置ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 9、变更广告信息审批
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式json
##### 请求方式put
##### 请求示范
http://192.168.100.20:8888/ad
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | ---- | | ---- | ---- | ---- | ---- |
| id | int | 是 | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | | | | | | |
##### 返回参数说明 ##### 返回参数说明
@ -191,10 +329,76 @@ http://192.168.100.20:8888/location
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- | | ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 | | code | int | 是 | 返回状态 |
| | | | |
##### 返回示例 ##### 返回示例
{ {
"code": 200 "code": 200
} }
#### 10、删除广告信息
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式json
##### 请求方式delete
##### 请求示范
http://192.168.100.20:8888/ad
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------------- |
| id | int | 是 | 需删除的位置ID |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}
#### 11、返回需播放的广告
##### 接口地址
http://192.168.100.20:8888/ad
##### 返回格式json
##### 请求方式get
##### 请求示范
http://192.168.100.20:8888/ad
##### 请求参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ---- | ---- | ------ |
| gameid | int | 是 | 游戏ID |
| locationid | int | 是 | 位置ID |
| | | | |
##### 返回参数说明
| 名称 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | -------- |
| code | int | 是 | 返回状态 |
##### 返回示例
{
"code": 200
}