由于早期開(kāi)放的一些API頁(yè)碼為0開(kāi)始,后期接口修改為從1開(kāi)始咬摇,為了兼顧之前的開(kāi)放API辙诞,故無(wú)法統(tǒng)一。
對(duì)于POST接口建議使用postman模擬
在編寫(xiě)過(guò)程中如果遇到一些問(wèn)題量淌,也有一些參考項(xiàng)目骗村,這里針對(duì)Java和Kotlin各自選擇了一款:
- java版本開(kāi)源:wanandroid開(kāi)源客戶(hù)端Java版本
- kotlin版本開(kāi)源:wanandroid開(kāi)源客戶(hù)端kotlin版本
當(dāng)然你也可以在github上搜索wanandroid。
返回?cái)?shù)據(jù)結(jié)構(gòu)定義:
{
"data": ...,
"errorCode": 0,
"errorMsg": ""
}
所有的返回結(jié)構(gòu)均為上述呀枢,其中errorCode如果為負(fù)數(shù)則認(rèn)為錯(cuò)誤胚股,此時(shí)errorMsg會(huì)包含錯(cuò)誤信息。data為Object裙秋,返回?cái)?shù)據(jù)根據(jù)不同的接口而變化琅拌。
如果遇到接口錯(cuò)誤,請(qǐng)及時(shí)通過(guò)https://github.com/hongyangAndroid/wanandroid反饋摘刑。
1.首頁(yè)相關(guān)
1.1 首頁(yè)文章列表
http://www.wanandroid.com/article/list/0/json
方法:GET
參數(shù):頁(yè)碼进宝,拼接在連接中,從0開(kāi)始枷恕。
可直接點(diǎn)擊查看示例:http://www.wanandroid.com/article/list/1/json党晋。
注意:頁(yè)碼從0開(kāi)始,拼接在鏈接上徐块。
1.2 首頁(yè)banner
http://www.wanandroid.com/banner/json
方法:GET
參數(shù):無(wú)
可直接點(diǎn)擊查看示例:http://www.wanandroid.com/banner/json
1.3 常用網(wǎng)站
http://www.wanandroid.com/friend/json
方法:GET
參數(shù):無(wú)
可直接點(diǎn)擊查看示例:http://www.wanandroid.com/friend/json
1.4 搜索熱詞
即目前搜索最多的關(guān)鍵詞未玻。
http://www.wanandroid.com//hotkey/json
方法:GET
參數(shù):無(wú)
可直接點(diǎn)擊查看示例:http://www.wanandroid.com/hotkey/json
2. 體系
2.1 體系數(shù)據(jù)
http://www.wanandroid.com/tree/json
方法:GET
參數(shù):無(wú)
可直接點(diǎn)擊查看示例:http://www.wanandroid.com/tree/json
主要標(biāo)識(shí)的網(wǎng)站內(nèi)容的體系結(jié)構(gòu),二級(jí)目錄胡控。部分?jǐn)?shù)據(jù)參考:
{
"children": [
{
"children": [],
"courseId": 13,
"id": 60, // id會(huì)在查看該目錄下所有文章時(shí)有用
"name": "Android Studio相關(guān)", // 子名稱(chēng)
"order": 1000,
"parentChapterId": 150,
"visible": 1
},...
],
"courseId": 13,
"id": 150,
"name": "開(kāi)發(fā)環(huán)境", // 一級(jí)的名稱(chēng)
"order": 1,
"parentChapterId": 0,
"visible": 1
}
2.2 知識(shí)體系下的文章
http://www.wanandroid.com/article/list/0?cid=60
方法:GET
參數(shù):
cid 分類(lèi)的id扳剿,上述二級(jí)目錄的id
頁(yè)碼:拼接在鏈接上,從0開(kāi)始昼激。
例如查看類(lèi)別:Android Studio下所有的文章:http://www.wanandroid.com/article/list/0?cid=60
3. 導(dǎo)航
3.1 導(dǎo)航數(shù)據(jù)
http://www.wanandroid.com/navi/json
方法:GET
參數(shù):無(wú)
可直接點(diǎn)擊查看示例:http://www.wanandroid.com/navi/json
4. 項(xiàng)目
4.1 項(xiàng)目分類(lèi)
http://www.wanandroid.com/project/tree/json
方法: GET
參數(shù): 無(wú)
項(xiàng)目為包含一個(gè)分類(lèi)庇绽,該接口返回整個(gè)分類(lèi)。
[
{
"children": [],
"courseId": 13,
"id": 294, // 該id在獲取該分類(lèi)下項(xiàng)目時(shí)需要用到
"name": "完整項(xiàng)目", // 該分類(lèi)名稱(chēng)
"order": 145000,
"parentChapterId": 293,
"visible": 0
}
]
可以直接訪(fǎng)問(wèn):http://www.wanandroid.com/project/tree/json
4.2 項(xiàng)目列表數(shù)據(jù)
某一個(gè)分類(lèi)下項(xiàng)目列表數(shù)據(jù)癣猾,分頁(yè)展示
http://www.wanandroid.com/project/list/1/json?cid=294
方法:GET
參數(shù):
cid 分類(lèi)的id敛劝,上面項(xiàng)目分類(lèi)接口
頁(yè)碼:拼接在鏈接中,從1開(kāi)始纷宇。
可以直接訪(fǎng)問(wèn):http://www.wanandroid.com/project/list/1/json?cid=294
5. 登錄與注冊(cè)
5.1 登錄
http://www.wanandroid.com/user/login
方法:POST
參數(shù):
username夸盟,password
5.2 注冊(cè)
http://www.wanandroid.com/user/register
方法:POST
參數(shù)
username,password,repassword
登錄后會(huì)在cookie中返回賬號(hào)密碼,只要在客戶(hù)端做cookie持久化存儲(chǔ)即可自動(dòng)登錄驗(yàn)證像捶。
6. 收藏
注意所有收藏相關(guān)都需要登錄操作上陕,建議登錄將返回的cookie(其中包含賬號(hào)、密碼)持久化到本地即可拓春。
6.1 收藏文章列表
http://www.wanandroid.com/lg/collect/list/0/json
方法:GET
參數(shù): 頁(yè)碼:拼接在鏈接中释簿,從0開(kāi)始。
在網(wǎng)站上登錄后硼莽,可以直接訪(fǎng)問(wèn)http://www.wanandroid.com/lg/collect/list/0/json查看自己收藏的文章庶溶。
6.2 收藏站內(nèi)文章
http://www.wanandroid.com/lg/collect/1165/json
方法:POST
參數(shù): 文章id,拼接在鏈接中。
注意鏈接中的數(shù)字偏螺,為需要收藏的id.
6.3 收藏站外文章
http://www.wanandroid.com/lg/collect/add/json
方法:POST
參數(shù):
title行疏,author,link
6.4 取消收藏
取消收藏一共有兩個(gè)地方可以觸發(fā):
6.4.1 文章列表
http://www.wanandroid.com/lg/uncollect_originId/2333/json
id傳入的是列表中文章的id套像。
6.4.2 我的收藏頁(yè)面(該頁(yè)面包含自己錄入的內(nèi)容)
http://www.wanandroid.com/lg/uncollect/2805/json
id傳入的是酿联,我的收藏文章列表的id。
6.5 收藏網(wǎng)站列表
http://www.wanandroid.com/lg/collect/usertools/json
方法:GET
參數(shù):無(wú)
6.6 收藏網(wǎng)址
http://www.wanandroid.com/lg/collect/addtool/json
方法:POST
參數(shù):
name,link
6.7 編輯收藏網(wǎng)站
http://www.wanandroid.com/lg/collect/updatetool/json
方法:POST
參數(shù):
id,name,link
6.8 刪除收藏網(wǎng)站
http://www.wanandroid.com/lg/collect/deletetool/json
方法:POST
參數(shù):
id
7. 搜索
7.1 搜索
http://www.wanandroid.com/article/query/0/json
方法:POST
參數(shù):
頁(yè)碼:拼接在鏈接上夺巩,從0開(kāi)始贞让。
k : 搜索關(guān)鍵詞
注意:支持多個(gè)關(guān)鍵詞,用空格隔開(kāi)