Readthis API 文档

Readthis

android 端移步此处

ios 端移步到此处

白皮书

功能点

手绘图

ui设计图

产品方向目标

lite版本需求说明

api 根目录 api.100000p.com

注意 该api 支持 http2 。 http2 比http1.1 更强悍。

API 文档

👉👉👉修改记录日志必看👈👈👈

注册√

授权√

时间线√

文章√

根据url查文章√

用户√

个性域名

微刊√

社群√

标签√

远程页面√

Android 更新api√

设置页面 api√

设计规范

Readthis 的 API 遵循现代 RESTful API 设计规范.

我不想bb什么是restful了。看下面

api风格 参考

阮一峰博客

ios对应风格api 参考

这有一本书 iOS Apps with REST APIs

api约定

1. 请求list列表时 都需要带上参数，size。 返回时，头部都会返回 count: 个数。

2. 如果查询只要id，则 在原来地址请求的对象下 加 _id 即可。文档中没有体现

例如 /v2/collections/:collectionId/articles_id 表示查某一微刊下的所有文章的id。

3. 当返回文章数组时候，不包括文章内容body字段。当返回单个文章时，返回body字段。

问题汇总。

1.分页问题。

使用游标。取列表最后一个的id，作为下一个请求的cursor参数。

第一次请求 20 条，显示10条，另外10条缓存起来，然后 加载更多的时候，从缓存中取出10条；然后从服务器请求10条 放缓存里。如果返回没有数据，则认为到达底部。这样好处是 体验上感觉很快。

2.登录问题

需要登录才能访问的api，如果没有登录，则返回 401 状态码。

登录需要在header里 写入 Token 。 Linux curl 示意，

curl -H "Token: xxxxx" http://xxxxx

所有api最好都带上 Token，除了注册登录。

3.返回415 怎么办。 http 头 需要加上

Content-type: application/json;charset=UTF-8

4.错误信息 从返回的 header 里的 code 里取得 错误码，body 返回如下实体。含义如下。

点这里查看 404 的例子

{
"httpCode": 2003,
"httpMsg": "没有这个文章"
}