tzxblog博客系统-接口文档

V1.0

接口安全说明

所有接口需要实现签名,前台向后台发起请求前需要在header中添加签名参数和签名,以减少后台服务器的被攻击可能性。
签名参数至少包含url、时间戳,有token的接口也需要对token签名,以参数名首字母排序后使用&符号拼接后,进行rsa256算法签名。


环境说明

环境名称协议IP/域名端口私钥
开发环境HTTP127.0.0.18080-
测试环境----
联调环境----
预生产环境----
生产环境----

统一响应对象

参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataObjectN响应结果

接口定义

文章分类或归档列表查询


接口名称文章分类或归档列表查询
URLtzxblog/blog/category-list
协议HTTP
请求类型GET
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
URL参数queryTypeStringYindex:首页; user:用户; recom:推荐;hot:热门; file:归档
userIdStringN用户id
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataListN分类对象列表,参见附录CategoryInfo

文章列表分页查询


接口名称文章列表分页查询
URLtzxblog/blog/blog-list
协议HTTP
请求类型GET
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
URL参数queryTypeStringYindex:首页;user:用户;recom:推荐;hot:热门;file:归档
pageIndexLongN页码,默认1
pagSizeLongN页数,默认10
userIdStringN用户id
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataPageInfoN分页博客对象,参见附录PageInfo

文章详情查询


接口名称文章详情查询
URLtzxblog/blog/bloginfo
协议HTTP
请求类型GET
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
URL参数blogIdStringY博客id
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataBlogInfoN博客对象

文章发布


接口名称文章发布
URLtzxblog/blog/add-blog
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYapplication/json
timestampStringY时间戳
signStringY签名
tokenStringYtoken
Body参数blogTitleStringY博客标题
blogContentStringY博客内容
blogCategroyStringY网站博客分类
blogUserCategroyStringY个人分类
blogTypeStringY博客类型: original:原创;reprint:转载;translate:翻译;
blogPowerStringY博客权限:private:私密;public:公开
响应参数参数名称数据类型是否必须参数描述
codeStringy响应码
msgStringy响应描述
requestIdStringy请求id
dataStringN博客id

文章删除


接口名称文章删除
URLtzxblog/blog/remove-blog
协议HTTP
请求类型DELETE
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
tokenStringYtoken
URL参数blogIdStringY博客id
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataStringN博客id

文章修改


接口名称文章修改
URLtzxblog/blog/update-blog
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYapplication/json
timestampStringY时间戳
signStringY签名
tokenStringYtoken
Body参数blogTitleStringY博客标题
blogContentStringY博客内容
blogCategroyStringY网站博客分类
blogUserCategroyStringY个人分类
blogTypeStringY博客类型:original:原创; reprint:转载;translate:翻译;
blogPowerStringY博客权限: private:私密;public:公开
响应参数参数名称数据类型是否必须参数描述
codeStringy响应码
msgStringy响应描述
requestIdStringy请求id
dataStringN博客id

评论列表分页查询


接口名称评论列表分页查询
URLtzxblog/comment/comment-list
协议HTTP
请求类型GET
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
URL参数pageIndexLongN页码,默认1
pagSizeLongN页数,默认10
userIdStringN用户id
blogIdStringN博客id
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataPageInfoN评论分页对象,参见附录PageInfo

文章评论


接口名称文章评论
URLtzxblog/comment/add-comment
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYapplication/json
timestampStringY时间戳
signStringY签名
tokenStringYtoken
Body参数blogIdStringY博客id
commentContentStringY评论内容
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataStringN博客id

文件列表分页查询


接口名称文件列表分页查询
URLtzxblog/file/file-list
协议HTTP
请求类型GET
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
URL参数pageIndexLongN页码,默认1
pagSizeLongN页数,默认10
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataPageInfo<FileInfoN评论分页对象,参见附录PageInfo<FileInfo

文件上传


接口名称文件上传
URLtzxblog/file/upload-file
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYmultipart/form-data
timestampStringY时间戳
signStringY签名
tokenStringYtoken
Form参数fileNameStringY文件名称
fileMultipartFileY文件
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataStringN文件id

文件下载


接口名称文件下载
URLtzxblog/file/download-file
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYmultipart/form-data
timestampStringY时间戳
signStringY签名
tokenStringYtoken
URL参数fileIdStringY文件id
响应参数参数名称数据类型是否必须参数描述
-----

用户基本信息查询


接口名称用户基本信息查询
URLtzxblog/user/userinfo
协议HTTP
请求类型GET
请求参数参数名称数据类型是否必须参数描述
Header参数timestampStringY时间戳
signStringY签名
URL参数userIdStringY用户id
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataUserInfoN用户信息

用户注册


接口名称用户注册
URLtzxblog/user/register
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYapplication/json
timestampStringY时间戳
signStringY签名
Body参数userAccountStringY账号
passwordStringY密码
rePasswordStringY密码确认
userPhoneStringY手机号
userEmailStringY邮箱
userNameStringN姓名
userNickStringN昵称
userAgeIntegerN年龄
userDescStringN简介
userAddrStringN地址
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataStringN用户id

用户登录


接口名称用户登录
URLtzxblog/user/login
协议HTTP
请求类型POST
请求参数参数名称数据类型是否必须参数描述
Header参数Content-TypeStringYapplication/json
timestampStringY时间戳
signStringY签名
Body参数userAccountStringY账号
passwordStringY密码
响应参数参数名称数据类型是否必须参数描述
codeStringY响应码
msgStringY响应描述
requestIdStringY请求id
dataLoginInfoN登录信息

附录

附录一

CategoryInfo

属性名数据类型是否必须属性描述
idStringY分类id
nameStringY分类名称

PageInfo

属性名数据类型是否必须属性描述
pageIndexLongY页码
pageSizeLongY每页数量
totalCountLongY总数
pageCountLongY页数
pageContentObjectN分页内容

BlogInfo

属性名数据类型是否必须属性描述
idStringY博客id
blogTitleStringY博客标题
blogAbstractStringY博客摘要
readCountLongY阅读数
commentCountLongY评论数
updateTimeStringY更新时间
createTimeStringY创建时间
blogContentStringY博客内容
blogCategroyStringY网站博客分类
blogUserCategroyStringY个人分类
blogTypeStringY博客类型: original:原创;reprint:转载;translate:翻译;
blogPowerStringY博客权限:private:私密; public:公开
userIdStringY用户id
userNickStringY用户昵称

CommentInfo

属性名数据类型是否必须属性描述
idStringY评论id
updateTimeStringY更新时间
createTimeStringY创建时间
commentContentStringY评论内容

FileInfo

属性名数据类型是否必须属性描述
idStringY文件id
updateTimeStringY更新时间
createTimeStringY创建时间
fileUrlStringY文件路径
fileNameStringY文件名称
fileDescStringY文件描述
downCountLongY下载次数

UserInfo

属性名数据类型是否必须属性描述
idStringY文件id
updateTimeStringY更新时间
createTimeStringY创建时间
userAccountStringY账号
userNameStringN姓名
userNickStringY昵称
userAgeIntegerN年龄
userDescStringN简介
userAddrStringN地址
userPhoneStringY手机号
userEmailStringY邮箱
userImgStringY头像url

LoginInfo

属性名数据类型是否必须属性描述
userUserInfoY用户对象
tokenUserTokenY用户token对象

UserToken

属性名数据类型是否必须属性描述
access_tokenStringYAT
expires_inLongYAT有效期
refresh_tokenStringYRT
refresh_expires_inLongYRT有效期
scopeStringN用户权限,备用

项目地址

项目代码和文档均以github托管,地址如下:
https://github.com/tuzongxun/tzxblog

涂宗勋 CSDN认证博客专家 web安全 系统安全 安全架构
从事java开发,现居湖北武汉,有过支付、OA、CA、OAUTH2等工作经验,现从事车联网行业。
爱好分享,个人博客blog.tzxcode.cn,微信tuzongxun,qq1160569243,欢迎来撩。
已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 成长之路 设计师:Amelia_0503 返回首页