美文网首页
接口文档

接口文档

作者: xiaoxin5230 | 来源:发表于2015-11-27 17:30 被阅读0次

WAG 接口规范

修订号 日期 描述 修订者 批准人/日期
1.0 2015/11/27  wag 接口规范 夏迎杰

帖子模块(Discovery)

名称 链接 支持方式 备注
获取帖子分类 /discovery/category post
新增帖子 /discovery/new post
采纳答案 /discovery/adoptAnswer post
首页 /discovery/list post
帖子详情 /discovery/detail post
举报 /discovery/accusation post
用户的贴文 /discovery/userList post
审核 /discovery/review post
修改帖文 /discovery/modify post

对象说明


Discovery对象

名称 说明 数据类型 是否必须
detail 信息描述 String Y
category 物品类型 String Y
type 1表示寻找,2表示招领 int Y
reward 酬金 非必须 double N
discoveryTime 丢失时间/捡到时间 long N
discoveryAddress 丢失地点/捡到地点 string N
dlatitude 物品丢失纬度 double N
dlongitude 物品丢失经度 double N
latitude 帖子发布纬度 double Y
longitude 帖子发布经度 double Y
image 图片 数组 N
address 发布信息地点,根据百度api自动获取实际地址 string Y
status 状态 //1表示审核通过 2表示需要审核 3.结贴 4被拒绝 int N
createAt 时间 long N
replyCount 评论数量 long N
favoriteCount 红星数量 long N
adoptAnswer 采纳答案 如果是审核状态,是没有这个字段,如果是0表示没有答案被采纳,否则是评论的id long N
user user对象 对象 Y

User对象

名称 说明 数据类型 是否必须
id 用户id long Y
nickName 用户名 string Y
img 用户头像 string数组 N
sex 性别 1表示男 ,2表示女,-1表示未设置 int Y

接口协议说明


请求使用HTTP POST模式。
应答返回json方式, json格式为:
code 说明:1为成功 非1为失败

{
"code":1
"msg":""
"data":{}
}

接口调用请求说明


获取帖子分类

/discovery/category

输入参数:

暂无参数

输出参数

名称 说明 数据类型
data 帖子类型数组 字符串数组

返回示例:

{
"code":1
"msg":""
"data":["手机","宠物"]
}

新增帖子

/discovery/new

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
accessToken |令牌|string|Y
detail |信息描述|string| Y
category| 物品类型 |String|Y
type |1表示寻找,2表示招领 |int|Y
reward |酬金 |double|N
discoveryTime |丢失时间/捡到时间 |long|N
discoveryAddress| 丢失地点/捡到地点 |string|N
dlatitude |丢失物品的纬度 |double|N
dlongitude |丢失物品的经度 |double|N
address |发布信息地点,根据百度api自动获取实际地址 可为空|string |N
latitude| 发布信息的纬度 |double|Y
longitude| 发布信息的经度 |double|Y
image| 图片|数组|N

输出参数

discovery对象

返回示例:

{
"code":1
"msg":""
"data":{
    discovery对象
}
}

采纳答案

/discovery/adoptAnswer

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
accessToken |令牌|string|Y
id|帖子id|long| Y
replyId | 评论id |long|Y

输出参数

返回示例:

{
"code":1
"msg":""
"data":{}
}

首页

/discovery/list

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
latitude |纬度|double|Y
longitude |经度 |double|Y
page|页数,默认为1|int|N
size|每页条数,默认为10|int|N
type|1表示寻找,2表示招领,不传表示所有|int |N
category |分类名称 ,不传表示所有|string|N
reward |表示悬赏 悬赏是酬金大于0的数据 |double|N

输出参数

名称 说明 数据类型
discovery discovery对象 里面增加sort字段,表示当前距离和发帖的距离,单位以m为计量单位 sort是double类型 对象
page 页数 long
size 每页条数 long
totalPage 总条数 long
totalSize 总条数 long

返回示例:

"code":1, 
"msg":"",
 "data":[{ discovery 对象}]
 "extra":{
     "page":1,
     "totalPage":2,
     "size":1,
     "totalSize":1 
}

帖子详情

/discovery/detail

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
id |discovery id|long|Y

输出参数

discovery对象

返回示例:

"code":1, 
"msg":"",
 "data":{ discovery 对象} 
}

举报

/discovery/accusation

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
accessToken |令牌|string|Y
id|帖子id|long| Y
type | 1广告 2 色情 3骚扰 4反对政治 5 其他|long|Y

输出参数

返回示例:

"code":1, 
"msg":"",
 "data":{ } 
}

用户的贴文

/discovery/userList

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
accessToken |令牌|string|Y
userId |用户的id,如果不存在则查询accessToken用户的帖子 |long|N
type| 1 表示用户审核通过的帖子,2表示未通过的帖子 如果不传表示所有的帖子|int|N
page|页数,默认为1|int|N
size|每页条数,默认为10|int|N

输出参数

名称 说明 数据类型
discovery discovery对象 里面增加sort字段,表示当前距离和发帖的距离,单位以m为计量单位 sort是double类型 对象
page 页数 long
size 每页条数 long
totalPage 总条数 long
totalSize 总条数 long

返回示例:

"code":1, 
"msg":"",
 "data":[{ discovery 对象}]
 "extra":{
     "page":1,
     "totalPage":2,
     "size":1,
     "totalSize":1 
}

审核

/discovery/review

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
accessToken |令牌|string|Y
id|帖子id|long| Y
status | 1过 2不过 说明:3次里面2次通过,5次里面3次通过|int|Y

输出参数

返回示例:

"code":1, 
"msg":"",
 "data":{ } 
}

修改帖文

/discovery/modify

帖子的状态为1,2能修改,其他状态不能修改

输入参数:

名称 |说明 |数据类型 |是否必须
---|---|---|
accessToken |令牌|string|Y
id|帖子id|string|Y
detail |信息描述|string| N
category| 物品类型 |String|N
type |1表示寻找,2表示招领 |int|N
reward |酬金 |double|N
discoveryTime |丢失时间/捡到时间 |long|N
discoveryAddress| 丢失地点/捡到地点 |string|N
dlatitude |丢失物品的纬度 |double|N
dlongitude |丢失物品的经度 |double|N
address |发布信息地点,根据百度api自动获取实际地址 可为空|string |N
latitude| 发布信息的纬度 |double|N
longitude| 发布信息的经度 |double|N
image| 图片|数组|N

输出参数

discovery对象

返回示例:

{
"code":1
"msg":""
"data":{
    discovery对象
}
}

相关文章

  • Vue应用框架整合与实战--前后端分离后的开发模式篇

    开发流程 后台编写和维护接口文档,在 API 变化时更新接口文档 后台根据接口文档进行接口开发 前端根据接口文档进...

  • 接码平台汇总

    短租接口文档 火云接口文档 火云官网 神话接口文档

  • 接口测试--接口文档规范

    接口测试的依据,往往不是需求文档,而是接口文档。 那么,接口文档的准确性便至关重要,本文推荐apipost接口文档...

  • 谈谈单接口测试

    如果只是单个接口的测试还是归属于功能测试。 平时我们是怎么做接口测试的?接口文档、接口文档,一定要看接口文档。初学...

  • 工作总结 文章目录

    工作总结 文章目录 狼人杀拾旧后台接口文档 狼人杀俱乐部后台接口文档 狼人杀接口文档 OA使用文档(报表,人事) ...

  • drf框架接口文档

    drf框架接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接...

  • 接口文档工具 apiPost

    ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试。 生成Mock...

  • 接口文档

    接口文档 1.登录 请求地址:/account/login请求方式:post 成功示例:{"ok":1,"data...

  • 接口文档

    第6节(判断数据库中是否有此用户) post www.test.com/api api.test.com

  • 接口文档

    1.获取铁甲云盒项目实时视频的API链接 接口地址: http:xxx:9998/tools/app_api.as...

网友评论

      本文标题:接口文档

      本文链接:https://www.haomeiwen.com/subject/sqmdhttx.html