TYPECHO WIKI

Typecho API 调用插件 Restful

更新日期:2018-10-09/ 人气指数:288

插件简介:

这是一个将 Typecho 博客 RESTful 化的插件。启用此插件,你可以通过请求 API 向站点请求或写入信息(获取文章内容、获取评论、添加评论等)。

插件安装:

1.常规安装

下载插件并解压,将解压后的目录重命名为 Restful (区分大小写),然后到后台插件管理页面启用并设置即可。

API 调用

下面假设您的站点已经开启了地址重写(伪静态);如果没有的话,那么需要在下文列出的请求的 URI 前加上 /index.php,例如:/api/posts => /index.php/api/posts.

一、文章列表

GET /api/posts
参数类型描述备注
pageint当前页可选
pageSizeint分页数可选
filterTypestringcategory 或 tag 或 search可选
filterSlugstring分类名或标签名或搜索关键字可选
showContentbool是否显示文章具体内容可选

二、页面列表

GET /api/pages

三、分类列表

GET /api/categories

四、标签列表

GET /api/tags

五、文章/页面详情

GET /api/post
参数类型描述备注
cidint文章/页面 ID二选一
slugstring文章/页面别名二选一

六、评论列表

GET /api/comments
参数类型描述备注
pageint当前页可选
pageSizeint分页数可选
orderstring评论显示顺序(asc/desc)可选
cidint文章 ID二选一
slugstring文章别名二选一

PS: 如果带上 Cookie 请求,会显示当前 Cookie 记住的用户所发布的待审核的评论。

七、最近评论

GET /api/recentComments
参数类型描述备注
sizeint最近评论的条数,默认为 9可选

八、发表评论

POST /api/comment
参数类型描述备注
cidint文章 ID二选一
slugstring文章别名二选一
parentint父级评论 ID可选
textstring评论内容必须
authorstring作者必须
mailstring邮箱必须
urlstringURL可选
tokenstring文章/页面详情返回的 token必须
uidint已注册用户评论时,用户的 UID可选
authCodestring已注册用户评论时,用户的 authCode可选

PS:此处Content-Type为application/json, 也就是说你应当以 JSON 格式提交数据。

PS2: uid 和 authCode 可以在 Cookie 中找到(形如 hash__typecho_uid 和 hash__typecho_authCode 的内容)。如果直接带上 Cookie 请求此 API 则不再需要带上 uid 和 authCode 参数。请求时需要带上合法的 User-Agent.

九、设置项

GET /api/settings

十、用户信息

GET /api/users
参数类型描述备注
uidint用户 ID可选
namestring用户的用户名或昵称可选

十一、归档

GET /api/archives

PS:默认按从新到旧 (desc) 顺序排列文章。

参数类型描述备注
showContentbool是否显示文章内容可选
orderstring归档的排序方式 (asc / desc)可选

其它设置

自定义 URI 前缀
默认情况下 Restful 插件会占用 /api/* 用于不同的接口。如果该 URI 有其它用途,或与其它插件冲突,或者由于某些不可描述的原因用户不希望暴露该接口,可以选择通过修改 config.inc.php 自定义前缀。

例如,在 config.inc.php 文件中加入下列内容:

define('__TYPECHO_RESTFUL_PREFIX__', '/rest/');

重新启用插件,此时你可以通过 /rest/* 访问相关 API.

如果本站有帮助到你请扫码打赏支持一下本站运营

赞助支持
下载地址

  更新时间:2018年10月09日

  软件作者:MoeFront Studio

  文件说明:Typecho API 调用插件 Restful

  下载链接: 链接1 链接2 广告推广你好污啊

添加新评论 »