登录

去注册

登录

注册

去登录

注册

玩Android 开放API

xiaoyang   2017-12-11   收藏

注意

为了满足大家开发小程序等需求,目前本站完全迁移到https下,如果你是开源项目开发者,请尽快迁移 base url 为 https。

目前已知问题:

  1. http 下登录、注册无法使用 -> 请使用https

baseurl 请使用:

https://www.wanandroid.com

将所有的 http 改为https,即完全支持!

一些更新

更新一些接口变化的地方,具体看对应章节。有问题请在https://github.com/hongyangAndroid/wanandroid/issues反馈。

2018-10-13 公众号Tab

增加微信公众号 Tab,查看公众号文章,支持搜索,。

获取公众号列表

https://wanandroid.com/wxarticle/chapters/json  
方法: GET

查看某个公众号历史数据

https://wanandroid.com/wxarticle/list/408/1/json
方法:GET
参数:
	公众号 ID:拼接在 url 中,eg:405
	公众号页码:拼接在url 中,eg:1

在某个公众号中搜索历史文章

https://wanandroid.com/wxarticle/list/405/1/json?k=Java
方法:GET
参数 :
	k : 字符串,eg:Java
	公众号 ID:拼接在 url 中,eg:405
	公众号页码:拼接在url 中,eg:1

2018-10-10 最新项目 Tab

最新项目tab (首页的第二个tab)

按时间分页展示所有项目。

https://wanandroid.com/article/listproject/0/json

方法:GET
参数:页码,拼接在连接中,从0开始。

2018-08-26

  1. 增加 logout 退出接口,见5.3;
  2. 修改未登录的错误码为-1001,其他错误码为-1,成功为0,建议对errorCode 判断当不为0的时候,均为错误。

由于早期开放的一些API页码为0开始,后期接口修改为从1开始,为了兼顾之前的开放API,故无法统一。

对于POST接口建议使用postman模拟

在编写过程中如果遇到一些问题,也有一些参考项目,这里针对Java和Kotlin各自选择了一款:

开源项目或多或少包含一些问题,仅供参考,最好自己写一个啦~
如果你想装一个使用,建议下载kotlin那个版本,我一直在使用,较为稳定。

当然你也可以在github上搜索wanandroid

返回数据结构定义:

{
    "data": ...,
    "errorCode": 0,
    "errorMsg": ""
}

所有的返回结构均为上述,其中errorCode如果为负数则认为错误,此时errorMsg会包含错误信息。data为Object,返回数据根据不同的接口而变化。

  1. errorCode = 0 代表执行成功,不建议依赖任何非0的 errorCode.
  2. errorCode = -1001 代表登录失效,需要重新登录。

如果遇到接口错误,请及时通过https://github.com/hongyangAndroid/wanandroid反馈。

对于需要登录访问的接口,强烈建议阅读下:

1.首页相关

1.1 首页文章列表

https://www.wanandroid.com/article/list/0/json

方法:GET
参数:页码,拼接在连接中,从0开始。

很多 H5 页面会恶意跳转淘宝等,可以在 webview 的 shouldOverrideUrlLoading 中做一下拦截,非常影响用户体验。

可直接点击查看示例:https://www.wanandroid.com/article/list/1/json

注意:页码从0开始,拼接在链接上。

其中有两个易混淆的字段:

"superChapterId": 153, 
"superChapterName": "framework", // 一级分类的名称

superChapterId其实不是一级分类id,因为要拼接跳转url,内容实际都挂在二级分类下,所以该id实际上是一级分类的第一个子类目的id,拼接后故可正常跳转。

1.2 首页banner

https://www.wanandroid.com/banner/json

方法:GET
参数:无

可直接点击查看示例:https://www.wanandroid.com/banner/json

1.3 常用网站

https://www.wanandroid.com/friend/json

方法:GET
参数:无

可直接点击查看示例:https://www.wanandroid.com/friend/json

1.4 搜索热词

即目前搜索最多的关键词。

https://www.wanandroid.com//hotkey/json

方法:GET
参数:无

可直接点击查看示例:https://www.wanandroid.com/hotkey/json

1.5 置顶文章

https://www.wanandroid.com/article/top/json

2. 体系

2.1 体系数据

https://www.wanandroid.com/tree/json

方法:GET
参数:无

可直接点击查看示例:https://www.wanandroid.com/tree/json

主要标识的网站内容的体系结构,二级目录。部分数据参考:

{
    "children": [
        {
            "children": [],
            "courseId": 13,
            "id": 60, // id会在查看该目录下所有文章时有用
            "name": "Android Studio相关", // 子名称
            "order": 1000,
            "parentChapterId": 150,
            "visible": 1
        },...
    ],
    "courseId": 13,
    "id": 150,
    "name": "开发环境", // 一级的名称
    "order": 1,
    "parentChapterId": 0,
    "visible": 1
}

2.2 知识体系下的文章

https://www.wanandroid.com/article/list/0/json?cid=60

方法:GET
参数:
	cid 分类的id,上述二级目录的id
	页码:拼接在链接上,从0开始。

例如查看类别:Android Studio下所有的文章:https://www.wanandroid.com/article/list/0/json?cid=60

3. 导航

3.1 导航数据

https://www.wanandroid.com/navi/json

方法:GET
参数:无

可直接点击查看示例:https://www.wanandroid.com/navi/json

4. 项目

4.1 项目分类

https://www.wanandroid.com/project/tree/json

方法: GET
参数: 无

项目为包含一个分类,该接口返回整个分类。

[
    {
        "children": [],
        "courseId": 13, 
        "id": 294, // 该id在获取该分类下项目时需要用到
        "name": "完整项目", // 该分类名称
        "order": 145000,
        "parentChapterId": 293,
        "visible": 0
    }
]

可以直接访问:https://www.wanandroid.com/project/tree/json

4.2 项目列表数据

某一个分类下项目列表数据,分页展示

https://www.wanandroid.com/project/list/1/json?cid=294

方法:GET
参数:
	cid 分类的id,上面项目分类接口
	页码:拼接在链接中,从1开始。

可以直接访问:https://www.wanandroid.com/project/list/1/json?cid=294

5. 登录与注册

5.1 登录

https://www.wanandroid.com/user/login

方法:POST
参数:
	username,password

登录后会在cookie中返回账号密码,只要在客户端做cookie持久化存储即可自动登录验证。

5.2 注册

https://www.wanandroid.com/user/register

方法:POST
参数
	username,password,repassword

5.3 退出

https://www.wanandroid.com/user/logout/json

方法:GET

访问了 logout 后,服务端会让客户端清除 Cookie(即cookie max-Age=0),如果客户端 Cookie 实现合理,可以实现自动清理,如果本地做了用户账号密码和保存,及时清理。

如果需要特殊的errorCode 来支持清除数据,请反馈。

6. 收藏

注意所有收藏相关都需要登录操作,建议登录将返回的cookie(其中包含账号、密码)持久化到本地即可。

对于需要登录访问的接口,强烈建议阅读下:

6.1 收藏文章列表

https://www.wanandroid.com/lg/collect/list/0/json

方法:GET
参数: 页码:拼接在链接中,从0开始。

在网站上登录后,可以直接访问https://www.wanandroid.com/lg/collect/list/0/json查看自己收藏的文章。

6.2 收藏站内文章

https://www.wanandroid.com/lg/collect/1165/json

方法:POST
参数: 文章id,拼接在链接中。

注意链接中的数字,为需要收藏的id.

6.3 收藏站外文章

https://www.wanandroid.com/lg/collect/add/json

方法:POST
参数:
	title,author,link

6.4 取消收藏

取消收藏一共有两个地方可以触发:

6.4.1 文章列表

https://www.wanandroid.com/lg/uncollect_originId/2333/json

方法:POST
参数:
	id:拼接在链接上

id传入的是列表中文章的id。

6.4.2 我的收藏页面(该页面包含自己录入的内容)

https://www.wanandroid.com/lg/uncollect/2805/json

方法:POST
参数:
	id:拼接在链接上
	originId:列表页下发,无则为-1

如下图:id=2766,originId=2324

originId 代表的是你收藏之前的那篇文章本身的id; 但是收藏支持主动添加,这种情况下,没有originId则为-1

6.5 收藏网站列表

https://www.wanandroid.com/lg/collect/usertools/json

方法:GET
参数:无

6.6 收藏网址

https://www.wanandroid.com/lg/collect/addtool/json

方法:POST
参数:
	name,link

6.7 编辑收藏网站

https://www.wanandroid.com/lg/collect/updatetool/json

方法:POST
参数:
	id,name,link

6.8 删除收藏网站

https://www.wanandroid.com/lg/collect/deletetool/json

方法:POST
参数:
	id

7. 搜索

7.1 搜索

https://www.wanandroid.com/article/query/0/json

方法:POST
参数:
	页码:拼接在链接上,从0开始。
	k : 搜索关键词

注意:支持多个关键词,用空格隔开

8. TODO 工具

最新的 v2版本已经更新,建议使用:玩 Android TODO Open API v2,老接口依然支持,但是已经不再推荐使用。

注意所有TODO相关都需要登录操作,建议登录将返回的cookie(其中包含账号、密码)持久化到本地即可。

对于需要登录访问的接口,强烈建议阅读下:

9.积分 API 2019-08-25

积分排行榜接口

https://www.wanandroid.com/coin/rank/1/json

获取个人积分,需要登录后访问

https://www.wanandroid.com/lg/coin/userinfo/json

{
    "data": {
        "coinCount": 451, //总积分
        "rank": 7, //当前排名
        "userId": 2,
        "username": "x**oyang"
    },
    "errorCode": 0,
    "errorMsg": ""
}

获取个人积分获取列表,需要登录后访问

https://www.wanandroid.com//lg/coin/list/1/json