zBlogDe-API文档

icy 07-28 261 抢沙发

默认

摘要： zBlogDe-Api通用响应JSON格式响应参数类型描述stateinteger返回状态 0=成功其他失败msgstring消息内容dataobject/array返回数据无需...

zBlogDe-Api

通用响应JSON格式

响应参数	类型	描述
state	integer	返回状态 0=成功其他失败
msg	string	消息内容
data	object/array	返回数据

无需验证的请求

系统初始化配置

get: /config

请求参数	类型	描述
path	string	网站根目录
r	string	如果有反向代理传入

post: /config

json body

字段	类型	描述
db-head	string	数据表前缀
db-type	integer	mysql=1000001,sqlite=1000002
database	string	数据库名/sqlite=文件名
db-server	string	数据库服务地址
db-user	string	数据库用户名
db-password	string	数据库密码
db-port	string	数据库端口
db-charset	string	数据库字符集
uid	integer	zBlog 用户ID
path	string	网站根目录
host	string	网址

返回 info页面

get: /login

请求参数	类型	描述
uname	string	登录名称
pw	string	密码(md5加密)

响应参数	类型	描述
token	string	验证-在其他请求的Header带上

系统信息

get: /info

响应参数	类型	描述
sys	object	系统基本信息
database	string	数据库
port	integer	端口
version	float	版本
uid	integer	用户ID
uname	string	用户名
nick	string	昵称
ZBlog	object	ZBlog配置信息
host	string	主页
path	string	博客网站路径
uid	integer	用户ID
db-type	string	数据库类型
database	string	数据库

get: /info/show

信息显示的HTML页面

需要验证的请求

发布任务

post: /release/article

json body

字段	类型	描述
logTitle	string	文章标题
taskTag	string	任务标签(查询用途)
cateId	integer	分类ID
cateName	string	分类名称
ctfile	string	文件下载(未安装留空即可)
logContent	string	文章内容(html)
logIntro	string	文章稿要
logMeta	string	zBlog-Meta
logTag	string	文章标签
logTemplate	string	文章模板
releaseTime	integer	发布时间默认0 为马上

form-data 方式同上除了 logContent 字段是上传文件形式一般是为内容过长的.

响应参数	类型	描述
id	integer	文章ID
title	string	文章标题
releaseTime	string	发布日期

读取发布文章任务

get: /release/list

请求参数	类型	描述
status	integer	状态 2=等待发布，9=发布完成

响应参数	类型	描述
data	object array	任务列表
id	integer	任务ID
taskTag	string	任务标签
createTime	string	创建日期
releaseTime	string	发布日期
completeTime	string	完成日期
logTitle	string	文章标题
cateName	string	分类名称

移除发布任务

delete: /release/remove

请求参数	类型	描述
ids	integer array	任务ID数组

返回通用基础 json

读取zBlog 标签

get: /zblog/tag/list

响应参数	类型	描述
data	object array	标签对象数组
tag_ID	integer	标签ID
tag_Name	string	标签名称

添加zBlog标签

post: /zblog/tag/add

form-data

表单参数	类型	描述
tags	json string array	["这是一个标签"]

返回基础通用 json

读取zBlog 分类列表

get: /zblog/cate/list

响应参数	类型	描述
data	object array	目录对象
cate_ID	integer	目录ID
cate_Name	string	目录名称
cate_LogTemplate	string	目录文章模板

读取zBlog的插件xcdown 分类什么的下载文件的[未安装忽略]

get: /zblog/xcdown/read

响应参数	类型	描述
types	string array	文件类型/zip/安装
dropboxs	string array	网盘/本地

修改zblog 的查看次数

put: /zblog/cate/view

form-data

字段	类型	描述
viewNums	integer	需要修改的查看次数
cateId	integer	分类ID

返回基础通用 json

上传文件到 zBlog

post: /zblog/upload

form-data

字段	类型	描述
file	binary	需要上传的文件

响应参数	类型	描述
imageUrl	string	文件地址

读取zblog 文章评论列表

get: /zblog/comment/list

请求参数	类型	描述
offset	integer	分页起始
limit	integer	分页结点

响应参数	类型	描述
data	object array	评论对象
comm_ID	integer	评论ID
comm_LogID	integer	文章ID
comm_IsChecking	integer	是否审核中
comm_RootID	integer	评论根ID
comm_ParentID	integer	评论父级ID
comm_AuthorID	integer	作者ID
comm_Name	string	作者名称
comm_Email	string	邮箱
comm_HomePage	string	首页
comm_Content	string	评论内容
comm_PostTime	integer	提交时间unixTime
comm_IP	string	评论客户端ID
comm_Agent	string	评论客户端
comm_Meta	string	zblog meta

删除zBlog评论内容

delete: /zblog/comment/remove

请求参数	类型	描述
id	integer	评论ID

返回基础通用 json

添加zblog文章评论

post: /zblog/comment/add

json body

字段	类型	描述
logId	integer	文章ID
isChecking	integer	审核中
rootId	integer	评论根ID
parentId	integer	评论父级ID
authorId	integer	作者ID
authorName	string	作者名称
email	string	邮箱
homePage	string	主页
content	string	评论内容