README.md · xenon007/light blog

# light blog

## API文档

### 返回结果demo

{"code":910,"message":"登陆成功","count":1,"data":[{"id":1,"username":"lkk","role":"normal"}]}

http code：`200`http请求成功，`404`页面不存在，`500`系统错误，`403`无权限

### 登陆接口

http://your-url/api/signIn/$username/$password

登陆成功：code `910` && message `登陆成功` && data `当前用户登录数据`

用户名或密码错误：code `810` && message `用户名或密码错误` && data `空`

已经登陆：code `911` && message `已经登陆` && data `当前用户登录数据`

### 注册接口

http://your-url/api/signUp/$username/$password/$blogType

blogType：1、文字博客 2、图片博客

注册成功：code `900` && message `操作成功` && data `空`

注册失败：code `800` && message `操作失败` && data `空` 原因：用户名长度超过12，或系统错误

注册失败：code `811` && message `用户名被占用` && data `空` 原因：用户名被占用

### 获取用户身份接口

http://your-url/api/getCurrentUser

获取成功：code `900` && message `操作成功` && data `user`

获取失败：code `912` && message `尚未登陆` && data `空`

### 创建新文章接口

http://your-url/api/createNewText

post={title:"", text_type: int, text:""}

text_type：0、默认 1、技术 2、安全 3、学科 4、新奇

提交成功：code `900` && message `操作成功` && data `文章信息`

提交失败：code `800` && message `操作失败` && data `空` 原因：参数不正确，其中title和text_type不能为空

提交失败：code `802` && message `请登陆· && data `空` 原因：用户没有登陆

### 登出接口

http://your-url/api/logout

登出成功：code `900` && message `操作成功` && data `空`

### 获取文章列表接口

http://your-url/api/getTextList/[$page_num = 1]/[$text_type = -1]/[$author_id = -1]/[$author_name = ""]/[$title = ""]/[$text = ""]/[$create_date = ""]

条件组合搜索：title含有`test`字符串

http://your-url/api/getTextList/1/-1/-1/NULL/test/[NULL]/[NULL]

$create_date = 2015-06-12 //用于搜索相关年月日的文章

P.S：$author_name、$title、$text都是模糊搜索（LIKE）

查询成功：code `900` && message `操作成功` && data `文章信息` && total `用于判断是否需要分页`

通过`count`判断`data`中是否有数据

data数组每一项:`id`,`title`,`text_type`(TestTypes),`author_id`,`author_name(int)`,`status`,`create_date`,`update_date`

### 获取个人全部文章接口

http://your-url/api/getSelfTextList

查询成功：code `900` && message `操作成功` && data `文章信息`

### 获取个人全部评论接口

http://your-url/api/getSelfCommentList

查询成功：code `900` && message `操作成功` && data `评论信息`

### 删除某条评论（在文章中）接口

http://your-url/api/delTextComment

删除成功：code 900` && message `操作成功` && data `comment (list)`

删除失败：code `800` && message `操作失败` && data `空`

删除失败：code `825` && message `没有该条评论` && data `空` 原因：参数不正确

### 删除评论（自己博客）接口

http://your-url/api/delSelfComment/$comment_id

操作成功：code `900` && message `操作成功` && data `comment (list)`

操作失败：code `800` && message `操作失败` && data `空`

删除失败：code `825` && message `没有该条评论` && data `空` 原因：参数不正确

### 通过文章ID获取文章具体和评论内容接口（无分页）

http://your-url/api/getTextAndCommentByTextId/$text_id/[keyword]

查询成功：code `900` && message `操作成功` && data `文章信息`

`id`(int),`text_type`(TestTypes),`title`,`author`(Users),`text`,`visible`,`status`,`comments(Comments array)`,`create_date`,`update_date`

其中:Comments `id`,`from(Users)`,`to(如果是评论文章的评论返回null，如果是回复返回User)`,`comment(text)`

查询失败：code `803` && message `无相关数据` && data `空`

### 留言接口

http://your-url/api/postWords/$blog_id/$the_word

提交成功：code `900` && message `操作成功` && data `留言列表`

提交失败：code `800` && message `操作失败` && data `空` 原因：参数不正确

### 某博客留言列表接口

http://your-url/api/getWordsByBlogId/$blog_id/[$page_num = 1]

查询成功：code `900` && message `操作成功` && data `留言列表` && total `用于判断是否需要分页`

### 获取自己博客所有留言接口

http://your-url/api/getSelfWordList

操作成功：code `900` && message `操作成功` && data `word (list)`

### 删除留言接口

http://your-url/api/delWordById/$word_id

操作成功：code `900` && message `操作成功` && data `word (list)`

操作失败：code `826` && message `没有该留言` && data `空`

### 提交评论接口

http://your-url/api/postComment/$text_id/$toUser = -1/$the_comment

提交成功：code `900` && message `操作成功` && data `comment (list)`

提交失败：code `800` && message `操作失败` && data `空` 原因：参数不正确

提交失败: code `821` && message `没有该文章` && data `空` 原因：传入的text_id并不存在于数据库

### 修改博客类型接口

http://your-url/api/changeBlogType/$blog_type(int)

修改成功：code `900` && message `操作成功` && data `user`

修改失败：code `800` && message `操作失败` && data `空` 原因：参数不正确

### 获取博客类型列表接口

http://your-url/api/getBlogTypeList

获取成功：code `900` && message `操作成功` && data `BlogType(list)`

### 获取文章类型列表接口

http://your-url/api/getTextTypeList

获取成功：code `900` && message `操作成功` && data `TextType(list)`

### 获取链接类型列表接口

http://your-url/api/getLinkTypeList

获取成功：code `900` && message `操作成功` && data `LinkType(list)`

### 删除文章接口（当前用户自己的文章）

http://your-url/api/delTextById/$text_id

操作成功：code `900` && message `操作成功` && data `text (list)`

无该文章：code `821` && message `没有该文章` && data `空` 原因：传入的text_id并不存在于用户的文章库中

操作失败：修改失败：code `800` && message `操作失败` && data `空`

### 修改文章接口（当前用户自己的文章）

http://your-url/api/updateText/$text_id

post={title:"", text_type: int, text:""} 参数不能缺少

操作成功：code `900` && message `操作成功` && data `文章信息`

无该文章：code `821` && message `没有该文章` && data `空` 原因：传入的text_id并不存在于用户的文章库中

修改失败：code `800` && message `操作失败` && data `空` 原因：传入的post参数错误

### 添加链接接口

http://your-url/api/addNewLink

post={title:"", url:"", hint:"", type:int} 参数不能缺少

操作成功：code `900` && message `操作成功` && data `link (list)`

操作失败：code `800` && message `操作失败` && data `空` 原因：传入的post参数错误

url格式错误：code `831` && message `超链接格式错误` $$ data `空`

### 删除连接接口

http://your-url/api/delLink/$link_id

操作成功：code `900` && message `操作成功` && data `link (list)`

无该链接：code `823` && message `没有该链接` && data `空` 原因：传入的link_id并不存在于用户的数据库中

### 修改链接接口

http://your-url/api/updateLink/$link_id

操作成功：code `900` && message `操作成功` && data `link (list)`

无该链接：code `823` && message `没有该链接` && data `空` 原因：传入的link_id并不存在于用户的数据库中

操作失败：code `800` && message `操作失败` && data `空` 原因：传入的post参数错误

url格式错误：code `831` && message `超链接格式错误` $$ data `空`

### 添加用户接口

http://your-url/api/addUser/$username/$password/$role

操作成功：code `900` && message `操作成功` && data `user (list)`

操作失败：code `800` && message `操作失败` && data `空` 原因：用户名被占用

操作是被：code `801` && message `非法输入` && data `空` 原因：role_id不能是0

### 修改用户密码接口

http://your-url/api/updateUserPassword/$user_id/$password

操作成功：code `900` && message `操作成功` && data `空`

操作失败：code `800` && message `操作失败` && data `空` 原因：没有修改

操作失败：code `824` && message `无相关用户` && data `空`

### 修改用户角色接口

http://your-url/api/updateUserRole/$user_id/$role

操作成功：code `900` && message `操作成功` && data `user (list)`

操作失败：code `800` && message `操作失败` && data `空` 原因：没有修改

操作失败：code `824` && message `无相关用户` && data `空`

操作失败：code `801` && message `非法输入` && data `空` 原因：role_id不能是0

### 设置推荐文章接口（自己）

http://your-url/api/textRecommend/$text_id

操作成功：code `900` && message `操作成功` && data `text (list)`

操作失败：code `800` && message `操作失败` && data `空`

操作失败：code `821` && message `无相关文章` && data `空`

### 取消推荐文章接口（自己）

http://your-url/api/textUndoRecommend/$text_id

同上

### 设置置顶文章接口（管理员）

http://your-url/api/textSetTop/$text_id

同上

### 取消置顶文章接口（管理员）

http://your-url/api/textUndoTop/$text_id

同上

### 设置文章不可见接口（管理员）

http://your-url/api/textSetVisible/$text_id

同上

### 取消文章不可见接口（管理员）

http://your-url/api/textSetInvisible/$text_id

同上

### 设置评论可见接口

http://your-url/api/commentSetVisible/$comment_id

操作成功：code `900` && message `操作成功` && data `comment (list)`

操作失败：code `800` && message `操作失败` && data `空`

操作失败：code `825` && message `没有该评论` && data `空`

### 设置评论不可见接口

http://your-url/api/commentSetInvisible/$comment_id

同上

### 获取所有用户列表接口(for admin)

http://your-url/api/getUserList

操作成功：code `900` && message `操作成功` && data `User (list)`

### 获取博客链接列表接口

http://your-url/api/getLinkList/$blog_id

操作成功：code `900` && message `操作成功` && data `Link (list)`

### 获取自己博客所有连接接口

http://your-url/api/getSelfLinkList

操作成功：code `900` && message `操作成功` && data `Link (list)`

### 获取所有文章接口（管理员）

http://your-url/api/getAllText

操作成功：code `900` && message `操作成功` && data `Text (list)`

xenon007/light blog

简介

发行版

贡献者

近期动态

xenon007/light blog .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

xenon007/light blog