WAG 接口規(guī)范
修訂號(hào) | 日期 | 描述 | 修訂者 | 批準(zhǔn)人/日期 |
---|---|---|---|---|
1.0 | 2015/11/27 | ? wag 接口規(guī)范 | 夏迎杰 |
帖子模塊(Discovery)
名稱 | 鏈接 | 支持方式 | 備注 |
---|---|---|---|
獲取帖子分類 | /discovery/category | post | |
新增帖子 | /discovery/new | post | |
采納答案 | /discovery/adoptAnswer | post | |
首頁(yè) | /discovery/list | post | |
帖子詳情 | /discovery/detail | post | |
舉報(bào) | /discovery/accusation | post | |
用戶的貼文 | /discovery/userList | post | |
審核 | /discovery/review | post | |
修改帖文 | /discovery/modify | post |
對(duì)象說(shuō)明
Discovery對(duì)象
名稱 | 說(shuō)明 | 數(shù)據(jù)類型 | 是否必須 |
---|---|---|---|
detail | 信息描述 | String | Y |
category | 物品類型 | String | Y |
type | 1表示尋找虑乖,2表示招領(lǐng) | int | Y |
reward | 酬金 非必須 | double | N |
discoveryTime | 丟失時(shí)間/撿到時(shí)間 | long | N |
discoveryAddress | 丟失地點(diǎn)/撿到地點(diǎn) | string | N |
dlatitude | 物品丟失緯度 | double | N |
dlongitude | 物品丟失經(jīng)度 | double | N |
latitude | 帖子發(fā)布緯度 | double | Y |
longitude | 帖子發(fā)布經(jīng)度 | double | Y |
image | 圖片 | 數(shù)組 | N |
address | 發(fā)布信息地點(diǎn),根據(jù)百度api自動(dòng)獲取實(shí)際地址 | string | Y |
status | 狀態(tài) //1表示審核通過(guò) 2表示需要審核 3.結(jié)貼 4被拒絕 | int | N |
createAt | 時(shí)間 | long | N |
replyCount | 評(píng)論數(shù)量 | long | N |
favoriteCount | 紅星數(shù)量 | long | N |
adoptAnswer | 采納答案 如果是審核狀態(tài)拣技,是沒(méi)有這個(gè)字段,如果是0表示沒(méi)有答案被采納耍目,否則是評(píng)論的id | long | N |
user | user對(duì)象 | 對(duì)象 | Y |
User對(duì)象
名稱 | 說(shuō)明 | 數(shù)據(jù)類型 | 是否必須 |
---|---|---|---|
id | 用戶id | long | Y |
nickName | 用戶名 | string | Y |
img | 用戶頭像 | string數(shù)組 | N |
sex | 性別 1表示男 过咬,2表示女,-1表示未設(shè)置 | int | Y |
接口協(xié)議說(shuō)明
請(qǐng)求使用HTTP POST模式制妄。
應(yīng)答返回json方式掸绞, json格式為:
code 說(shuō)明:1為成功 非1為失敗
{
"code":1
"msg":""
"data":{}
}
接口調(diào)用請(qǐng)求說(shuō)明
獲取帖子分類
/discovery/category
輸入?yún)?shù):
暫無(wú)參數(shù)
輸出參數(shù)
名稱 | 說(shuō)明 | 數(shù)據(jù)類型 |
---|---|---|
data | 帖子類型數(shù)組 | 字符串?dāng)?shù)組 |
返回示例:
{
"code":1
"msg":""
"data":["手機(jī)","寵物"]
}
新增帖子
/discovery/new
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
accessToken |令牌|string|Y
detail |信息描述|string| Y
category| 物品類型 |String|Y
type |1表示尋找,2表示招領(lǐng) |int|Y
reward |酬金 |double|N
discoveryTime |丟失時(shí)間/撿到時(shí)間 |long|N
discoveryAddress| 丟失地點(diǎn)/撿到地點(diǎn) |string|N
dlatitude |丟失物品的緯度 |double|N
dlongitude |丟失物品的經(jīng)度 |double|N
address |發(fā)布信息地點(diǎn)耕捞,根據(jù)百度api自動(dòng)獲取實(shí)際地址 可為空|string |N
latitude| 發(fā)布信息的緯度 |double|Y
longitude| 發(fā)布信息的經(jīng)度 |double|Y
image| 圖片|數(shù)組|N
輸出參數(shù)
discovery對(duì)象
返回示例:
{
"code":1
"msg":""
"data":{
discovery對(duì)象
}
}
采納答案
/discovery/adoptAnswer
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
accessToken |令牌|string|Y
id|帖子id|long| Y
replyId | 評(píng)論id |long|Y
輸出參數(shù)
無(wú)
返回示例:
{
"code":1
"msg":""
"data":{}
}
首頁(yè)
/discovery/list
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
latitude |緯度|double|Y
longitude |經(jīng)度 |double|Y
page|頁(yè)數(shù)衔掸,默認(rèn)為1|int|N
size|每頁(yè)條數(shù),默認(rèn)為10|int|N
type|1表示尋找俺抽,2表示招領(lǐng),不傳表示所有|int |N
category |分類名稱 ,不傳表示所有|string|N
reward |表示懸賞 懸賞是酬金大于0的數(shù)據(jù) |double|N
輸出參數(shù)
名稱 | 說(shuō)明 | 數(shù)據(jù)類型 |
---|---|---|
discovery | discovery對(duì)象 里面增加sort 字段敞映,表示當(dāng)前距離和發(fā)帖的距離,單位以m為計(jì)量單位 sort是double類型 |
對(duì)象 |
page | 頁(yè)數(shù) | long |
size | 每頁(yè)條數(shù) | long |
totalPage | 總條數(shù) | long |
totalSize | 總條數(shù) | long |
磷斧,
返回示例:
"code":1,
"msg":"",
"data":[{ discovery 對(duì)象}]
"extra":{
"page":1,
"totalPage":2,
"size":1,
"totalSize":1
}
帖子詳情
/discovery/detail
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
id |discovery id|long|Y
輸出參數(shù)
discovery對(duì)象
返回示例:
"code":1,
"msg":"",
"data":{ discovery 對(duì)象}
}
舉報(bào)
/discovery/accusation
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
accessToken |令牌|string|Y
id|帖子id|long| Y
type | 1廣告 2 色情 3騷擾 4反對(duì)政治 5 其他|long|Y
輸出參數(shù)
無(wú)
返回示例:
"code":1,
"msg":"",
"data":{ }
}
用戶的貼文
/discovery/userList
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
accessToken |令牌|string|Y
userId |用戶的id振愿,如果不存在則查詢accessToken用戶的帖子 |long|N
type| 1 表示用戶審核通過(guò)的帖子捷犹,2表示未通過(guò)的帖子 如果不傳表示所有的帖子|int|N
page|頁(yè)數(shù),默認(rèn)為1|int|N
size|每頁(yè)條數(shù)冕末,默認(rèn)為10|int|N
輸出參數(shù)
名稱 | 說(shuō)明 | 數(shù)據(jù)類型 |
---|---|---|
discovery | discovery對(duì)象 里面增加sort 字段萍歉,表示當(dāng)前距離和發(fā)帖的距離,單位以m為計(jì)量單位 sort是double類型 |
對(duì)象 |
page | 頁(yè)數(shù) | long |
size | 每頁(yè)條數(shù) | long |
totalPage | 總條數(shù) | long |
totalSize | 總條數(shù) | long |
返回示例:
"code":1,
"msg":"",
"data":[{ discovery 對(duì)象}]
"extra":{
"page":1,
"totalPage":2,
"size":1,
"totalSize":1
}
審核
/discovery/review
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
accessToken |令牌|string|Y
id|帖子id|long| Y
status | 1過(guò) 2不過(guò) 說(shuō)明:3次里面2次通過(guò)档桃,5次里面3次通過(guò)|int|Y
輸出參數(shù)
無(wú)
返回示例:
"code":1,
"msg":"",
"data":{ }
}
修改帖文
/discovery/modify
帖子的狀態(tài)為1枪孩,2能修改,其他狀態(tài)不能修改
輸入?yún)?shù):
名稱 |說(shuō)明 |數(shù)據(jù)類型 |是否必須
---|---|---|
accessToken |令牌|string|Y
id|帖子id|string|Y
detail |信息描述|string| N
category| 物品類型 |String|N
type |1表示尋找藻肄,2表示招領(lǐng) |int|N
reward |酬金 |double|N
discoveryTime |丟失時(shí)間/撿到時(shí)間 |long|N
discoveryAddress| 丟失地點(diǎn)/撿到地點(diǎn) |string|N
dlatitude |丟失物品的緯度 |double|N
dlongitude |丟失物品的經(jīng)度 |double|N
address |發(fā)布信息地點(diǎn)蔑舞,根據(jù)百度api自動(dòng)獲取實(shí)際地址 可為空|string |N
latitude| 發(fā)布信息的緯度 |double|N
longitude| 發(fā)布信息的經(jīng)度 |double|N
image| 圖片|數(shù)組|N
輸出參數(shù)
discovery對(duì)象
返回示例:
{
"code":1
"msg":""
"data":{
discovery對(duì)象
}
}