美文网首页
协会官网接口v1.1

协会官网接口v1.1

作者: 游泽渠 | 来源:发表于2017-01-22 20:52 被阅读0次

1.0
创建接口

1.1
更新了关于评论的接口,简化了接口的使用,增加了意见反馈部分和oauth部分,接口时间格式统一为时间戳


接口格式

RequestAddress:
//请求发送的地址
"我是一个地址"

RequestMethod:
//发送请求的形式,post/get
"我是一个请求类型"

Request:
//请求的所需内容
{
    //我是一个json数组
    object=>{
      //我是一个对象,object是我的名字
      title : (string),
      //title是我的属性名,string是我的类型      
    },
    key : (int),
    //我是数组中的一个键,key是名字,int是类型
}

Respond:
//请求的回应
[ 形式和上面的一样,也是json数组 ]

近期活动部分

RequestAddress: 

RequestMethod:
get

Request: 
NULL

Respond: 
{
    //注意activity的对象数组可能有一个或者是两个
    //也就是说activity2这个东西不一定存在
    "activity"=>
    [{
        "title" : (string),   //活动标题,无限杯电子设计大赛
        "content" : (string), //活动简介
        "schedule"=>
        [{ //这里是日程表
          "stage" : (string),  //阶段
          "beginTime" : (int), //时间戳,开始时间
          "endTime" : (int),   //时间戳,结束时间
          "place" : (string),  //地点
        },
        {
        },
        {
        },
        {
        }],
        "signUpLink" : (string)  //报名的链接,这个在为false的情况下,说明报名未开始或者已经截止
        "posterLink" : (string)  //海报的链接
    },//activity1
    {
    }],//activity2
}

活动报道部分

一、活动报道
RequestAddress:

RequestMethod:
get

Request:
{
    "page" : (int)  //访问的页码,首次访问默认应该发送1,也就是第一页
}

Respond:
{
    "totalPage" : (int)  //总的页数
    //注意,报道为1-3个,不一定都是三个
    "report"=>
    [{  //第一个报道
        "reportId" : (string),        //文章的id号
        "title" : (string),           //报道的标题
        "abstract" : (string),        //报道的简介
        "updateTime" : (int),         //报道的更新时间,对应于日期
        "surfacePlotUrl" : (string),  //标题图的链接
    },
    {  //第二个报道
        "reportId" : (string),      
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
    },
    {  //第三个报道    
        "reportId" : (string),  
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
    }]
}
二、活动报道详情
RequestAddress:

RequestType:
get

Request:
[
    "reportId" : (int)  //报道的id号
]

Respond:
{
    "reportUrl" : (string)      //报道的文章地址
    "commentTotalPage" : (int)  //评论总的页数
    //每页的评论最多有三条
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
三、评论翻页
RequestAddress:

RequestType:
get

Request:
{
    "reportId" : (int)               //报道的id号
    "commentCurrentPage" : (string)  //评论的页码
}

Respond:
{
    //注意评论不一定有三个
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
四、提交评论
RequestAddress:

RequestType:
post

Request:
{
    "content" : (string) //评论的内容
    "reportId" : (int)   //报道的id号
}

Respond:
{
    "state" : (int)  //0代表失败,1代表成功,2代表没有登录
}

作品集锦部分

RequestAddress:

RequestMethod:
get

Request:
{
    "page" : (int)  //访问的页码,首次访问默认应该发送1,也就是第一页
}

Respond:
{
    "totalPage" : (int)  //总的页数
    //注意,作品为1-3个,不一定都是三个
    "works"=>
    [{  //第一个作品
        "title" : (string),           //作品的标题
        "abstract" : (string),        //作品的简介
        "updateTime" : (int),         //作品的更新时间,对应于日期
        "surfacePlotUrl" : (string),  //标题图的链接
        "worksUrl" : (string),        //文章的链接
    },
    {  //第二个作品   
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "worksUrl" : (string),     
    },
    {  //第三个作品     
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "worksUrl" : (string),    
    }]
}

维修技巧部分

一、维修技巧
RequestAddress:

RequestMethod:
get

Request:
{
    "page" : (int)  //访问的页码,首次访问默认应该发送1,也就是第一页
}

Respond:
{
    "totalPage" : (int)  //总的页数
    //注意,维修技巧为1-3个,不一定都是三个
    "skill"=>
    [{  //第一个维修技巧
        "title" : (string),           //维修技巧的标题
        "abstract" : (string),        //维修技巧的简介
        "updateTime" : (int),         //维修技巧的更新时间,对应于日期
        "surfacePlotUrl" : (string),  //标题图的链接
        "skillId" : (string),         //文章的id号
    },
    {  //第二个维修技巧      
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "skillId" : (string),     
    },
    {  //第三个维修技巧     
        "title" : (string),           
        "abstract" : (string),        
        "updateTime" : (int),         
        "surfacePlotUrl" : (string), 
        "skillId" : (string),    
    }]
}
二、维修技巧文章
RequestAddress:

RequestType:
get

Request:
{
    "skillId" : (int)  //维修技巧的id号
}

Respond:
{
    //评论数量可能为0,1,2,3
    "skillUrl" : (string)       //维修技巧的文章地址
    "commentTotalPage" : (int)  //评论总的页数
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
三、评论翻页
RequestAddress:

RequestType:
get

Request:
{
    "skillId" : (int)                //维修技巧的id号
    "commentCurrentPage" : (string)  //评论的页码
}

Respond:
{
    //注意评论不一定有三个
    "comment"=>
    [{
        "user" : (string),          //评论人
        "userFigureUrl" : (string), //评论人的头像地址
        "createTime" : (int),       //创建时间戳
        "content" : (string),       //评论内容
    },
    {
        //同上
    },
    {
        //同上
    }]
}
四、提交评论
RequestAddress:

RequestType:
post

Request:
{
    "content" : (string) //评论的内容
    "skillId" : (int)    //维修技巧的id号
}

Respond:
{
    "state" : (int)  //0代表失败,1代表成功,2代表未登录
}

预约申请部分

一、获得预约信息
RequestAddress:

RequestType:
get

Request:
NULL

Respond:
{
    "isOrder" : (int),    //是否该用户有预约维修
    "underExam" : (int),  //在有预约的时候显示预约审核进度,0为未审核,1为通过,2为不通过
                          //在没有预约的时候一定为0 
}
二、进行预约
//这个接口只有在这个用户没有预约过的时候开放
//如果该用户当前有预约,那么这个接口一定会返回失败信息
RequestAddress:

RequestType:
post

Request:
{
    "name" : (string),        //预约人的名字
    "phoneNumber" : (string), //手机号,默认11位,格式非法的电话号码无法通过预约
    "campus" : (int),         //校区信息,南校为0,北校为1
    "dormitory" : (string),   //宿舍的信息,最长30
    "itemName" : (string),    //修理物品的名字,最长80
    "description" : (string), //修理物品损坏情况的具体描述
}

Respond:
{
    isSuccess : (int), //0表示失败,1表示成功
}

意见反馈部分

这里的UI有一些问题,所以加了分页

一、获取反馈
RequestAddress:

RequestType:
get

Request:
{
    "page" : (int), //访问的页码,第一次进入应该为1
}

Respond:
{
    "totalPage" : (int) //评论的总页数
    //每一页反馈最多有三条
    "feedback"=>
    [{
        "feedbackCreateTime" : (int), //反馈的创建时间
        "feedbackContent" : (string), //反馈的内容 
        "respondCreateTime" : (int),  //回应的创建时间
        "respondContent" : (string),  //回应的内容
    },
    {
    },
    {
    }]
}
二、提交反馈
RequestAddress:

RequestType:
post

Request:
{
    "content" : (string), //反馈的内容
}

Respond:
{
    "state" : (int), //0表示失败,1成功,2未登录
}

QQ授权部分

一、获取用户信息

该接口用于用户授权结束后获取用户信息,或者说是用户更改了自身的qq信息,想要刷新的情况
注意:该接口每日调用数量有限,预计为每日一次

RequestAddress: (暂定OAuth/get-user-info-refresh)

RequestType:
post

Request:

Response:
{
    state:(int)           //成功为1,失败为0,并且在失败的情况下以下的参数全部没有           
    nick_name:(string)    //用户在QQ空间的昵称,如"Peter"
    figureurl:(string)    //大小为40×40像素的QQ头像URL,如"http://qzapp.qlogo.cn/qzapp/111111/942FEA70050EEAFBD4DCE2C1FC775E56/30"
}
二、重新获取用户信息

该接口用于在本地缓存的用户信息丢失的情况下从后端数据库重新获取用户信息

RequestAddress: (暂定OAuth/get-user-info)

RequestType:
get

Request:

Response:
{
    state:(int)           //成功为1,失败为0,并且在失败的情况下以下的参数全部没有
    nick_name:(string)    //用户在QQ空间的昵称,如"Peter"
    figureurl:(string)    //大小为40×40像素的QQ头像URL,如"http://qzapp.qlogo.cn/qzapp/111111/942FEA70050EEAFBD4DCE2C1FC775E56/30"
}

相关文章

网友评论

      本文标题:协会官网接口v1.1

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