插件介绍

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

插件安装

1.常规安装

此处内容需要评论回复后(审核通过)方可阅读。

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

API 使用文档

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

接口说明

接口名可用参数默认值说明
postspageSize
page
authorId
created
cid
category
commentsNumMax
commentsNumMin
allowComment
5
1
0
-
-
-
-
-
-
文章综合数据
pageListcontentfalse页面综合数据
singlecid
slug
-
-
指定单页面数据
post同上同上指定文章数据
page同上同上指定页面数据
relatedPostsauthorId
limit
type
cid
-
5
-
-
关联文章数据
recentPostpageSize10最新文章数据
recentCommentspageSize
parentId
ignoreAuthor
showCommentOnly
10
0
false
false
最近评论数据
categoryListignore
childMode
-
false
分类列表数据
archiveformat
type
limit
Y-m
month
0
归档列表数据
tagCloudsort
ignoreZeroCount
desc
limit
count
false
true
0
infouser0配置信息数据
count--发表文章总数

其它设置

自定义 URI 前缀

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

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

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

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

Last modification:May 11th, 2020 at 05:29 pm
如果觉得我的文章对你有用,请随意赞赏