1.0
創(chuàng)建接口
1.1
更新了關(guān)于評論的接口,簡化了接口的使用,增加了意見反饋部分和oauth部分,接口時間格式統(tǒng)一為時間戳
接口格式
RequestAddress:
//請求發(fā)送的地址
"我是一個地址"
RequestMethod:
//發(fā)送請求的形式,post/get
"我是一個請求類型"
Request:
//請求的所需內(nèi)容
{
//我是一個json數(shù)組
object=>{
//我是一個對象,object是我的名字
title : (string),
//title是我的屬性名,string是我的類型
},
key : (int),
//我是數(shù)組中的一個鍵,key是名字,int是類型
}
Respond:
//請求的回應
[ 形式和上面的一樣,也是json數(shù)組 ]
近期活動部分
RequestAddress:
RequestMethod:
get
Request:
NULL
Respond:
{
//注意activity的對象數(shù)組可能有一個或者是兩個
//也就是說activity2這個東西不一定存在
"activity"=>
[{
"title" : (string), //活動標題,無限杯電子設計大賽
"content" : (string), //活動簡介
"schedule"=>
[{ //這里是日程表
"stage" : (string), //階段
"beginTime" : (int), //時間戳,開始時間
"endTime" : (int), //時間戳,結(jié)束時間
"place" : (string), //地點
},
{
},
{
},
{
}],
"signUpLink" : (string) //報名的鏈接,這個在為false的情況下,說明報名未開始或者已經(jīng)截止
"posterLink" : (string) //海報的鏈接
},//activity1
{
}],//activity2
}
活動報道部分
一、活動報道
RequestAddress:
RequestMethod:
get
Request:
{
"page" : (int) //訪問的頁碼,首次訪問默認應該發(fā)送1,也就是第一頁
}
Respond:
{
"totalPage" : (int) //總的頁數(shù)
//注意,報道為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) //評論總的頁數(shù)
//每頁的評論最多有三條
"comment"=>
[{
"user" : (string), //評論人
"userFigureUrl" : (string), //評論人的頭像地址
"createTime" : (int), //創(chuàng)建時間戳
"content" : (string), //評論內(nèi)容
},
{
//同上
},
{
//同上
}]
}
三、評論翻頁
RequestAddress:
RequestType:
get
Request:
{
"reportId" : (int) //報道的id號
"commentCurrentPage" : (string) //評論的頁碼
}
Respond:
{
//注意評論不一定有三個
"comment"=>
[{
"user" : (string), //評論人
"userFigureUrl" : (string), //評論人的頭像地址
"createTime" : (int), //創(chuàng)建時間戳
"content" : (string), //評論內(nèi)容
},
{
//同上
},
{
//同上
}]
}
四、提交評論
RequestAddress:
RequestType:
post
Request:
{
"content" : (string) //評論的內(nèi)容
"reportId" : (int) //報道的id號
}
Respond:
{
"state" : (int) //0代表失敗,1代表成功,2代表沒有登錄
}
作品集錦部分
RequestAddress:
RequestMethod:
get
Request:
{
"page" : (int) //訪問的頁碼,首次訪問默認應該發(fā)送1,也就是第一頁
}
Respond:
{
"totalPage" : (int) //總的頁數(shù)
//注意,作品為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) //訪問的頁碼,首次訪問默認應該發(fā)送1,也就是第一頁
}
Respond:
{
"totalPage" : (int) //總的頁數(shù)
//注意,維修技巧為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:
{
//評論數(shù)量可能為0,1,2,3
"skillUrl" : (string) //維修技巧的文章地址
"commentTotalPage" : (int) //評論總的頁數(shù)
"comment"=>
[{
"user" : (string), //評論人
"userFigureUrl" : (string), //評論人的頭像地址
"createTime" : (int), //創(chuàng)建時間戳
"content" : (string), //評論內(nèi)容
},
{
//同上
},
{
//同上
}]
}
三、評論翻頁
RequestAddress:
RequestType:
get
Request:
{
"skillId" : (int) //維修技巧的id號
"commentCurrentPage" : (string) //評論的頁碼
}
Respond:
{
//注意評論不一定有三個
"comment"=>
[{
"user" : (string), //評論人
"userFigureUrl" : (string), //評論人的頭像地址
"createTime" : (int), //創(chuàng)建時間戳
"content" : (string), //評論內(nèi)容
},
{
//同上
},
{
//同上
}]
}
四、提交評論
RequestAddress:
RequestType:
post
Request:
{
"content" : (string) //評論的內(nèi)容
"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), //校區(qū)信息,南校為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) //評論的總頁數(shù)
//每一頁反饋最多有三條
"feedback"=>
[{
"feedbackCreateTime" : (int), //反饋的創(chuàng)建時間
"feedbackContent" : (string), //反饋的內(nèi)容
"respondCreateTime" : (int), //回應的創(chuàng)建時間
"respondContent" : (string), //回應的內(nèi)容
},
{
},
{
}]
}
二、提交反饋
RequestAddress:
RequestType:
post
Request:
{
"content" : (string), //反饋的內(nèi)容
}
Respond:
{
"state" : (int), //0表示失敗,1成功,2未登錄
}
QQ授權(quán)部分
一、獲取用戶信息
該接口用于用戶授權(quán)結(jié)束后獲取用戶信息,或者說是用戶更改了自身的qq信息,想要刷新的情況
注意:該接口每日調(diào)用數(shù)量有限,預計為每日一次
RequestAddress: (暫定OAuth/get-user-info-refresh)
RequestType:
post
Request:
Response:
{
state:(int) //成功為1,失敗為0,并且在失敗的情況下以下的參數(shù)全部沒有
nick_name:(string) //用戶在QQ空間的昵稱,如"Peter"
figureurl:(string) //大小為40×40像素的QQ頭像URL,如"http://qzapp.qlogo.cn/qzapp/111111/942FEA70050EEAFBD4DCE2C1FC775E56/30"
}
二、重新獲取用戶信息
該接口用于在本地緩存的用戶信息丟失的情況下從后端數(shù)據(jù)庫重新獲取用戶信息
RequestAddress: (暫定OAuth/get-user-info)
RequestType:
get
Request:
Response:
{
state:(int) //成功為1,失敗為0,并且在失敗的情況下以下的參數(shù)全部沒有
nick_name:(string) //用戶在QQ空間的昵稱,如"Peter"
figureurl:(string) //大小為40×40像素的QQ頭像URL,如"http://qzapp.qlogo.cn/qzapp/111111/942FEA70050EEAFBD4DCE2C1FC775E56/30"
}