阳光沙滩博客系统API接口

分两部分：用户的API接口、门户的API接口

在线预览网址：

博客系统

baseUrl

http://api.coincent.cn

统一返回结果bean类

ResponseResult{
code	integer($int32)
data	{...}
message	string
success	boolean
}

用户API接口

用户bean类

SobUser{
avatar	string
createTime	string($date-time)
email	string
id	string
loginIp	string
password	string
regIp	string
roles	string
sign	string
state	string
updateTime	string($date-time)
userName	string
}

用户登录

• 接口：

/user/account/login/{captcha}/

• 方法：POST
• 参数
  • captcha string(path,必须) 验证码，图灵验证码，请看后面的接口
  • sobUser SobUser(body,必须) 登录信息，邮箱/用户名，密码（md5值）
  • from 来源，非必须，来源，不填写为m_为手机端登录，p_为PC端登录
• 返回：
  • 20000 成功
  • 40003 账号被禁止
  • 40000 失败-详情请看提示信息

退出登录

• 接口：

/user/account/logout

• 方法：GET
• 参数：无
• 返回：
  • 40002 账号未登录
  • 20000 成功

查询二维码的登录状态

• 接口：

/user/account/qr_code_state/{loginId}

• 方法：GET
• 参数：
  • loginId 登录的ID，获取二维的时候会返回，请看后面的接口
• 返回：
  • 40008 等待扫描
  • 40009 二维码已过期
  • 20001 登录成功

更新二维码的登录状态

手机端使用此接口

• 接口：

/user/account/qr_code_state/{loginId}

• 方法：PUT
• 参数
  • loginId 登录的ID，扫码解析可以获取到
• 返回：
  • 40002 账号未登录（指你手机的账号未登录）
  • 20000 登录成功

更新用户邮箱地址

步骤：先获取邮箱验证码，获取到邮箱验证码再来更新邮箱

• 接口：

/user/email

• 方法：PUT
• 参数：
  • email string类型，新邮箱地址，query，必须
  • verify_code string类型，邮箱验证码， query，必须
• 返回：
  • 40002 账号未登录
  • 40000 验证码错误
  • 20000 修改成功

用户注册

• 接口：

/user/join_in

• 方法：POST
• 参数
  • captcha_code string类型 query 图灵验证码 必须
  • email_code string类型 query 邮箱验证码 必须
  • sobUser SobUser类型 body 用户名、邮箱地址、密码（MD5值）必须
• 返回：
  • 40000 操作失败，请看提示信息
  • 20002 注册成功

更新用户密码

步骤：获取邮箱验证码，需要提交邮箱和验证码以及新的密码（md5值）

• 接口：

/user/password/{verifyCode}

• 方法：PUT
• 参数
  • verifyCode 邮箱验证码string类型，要与提交的邮箱地址对应，必须
  • sobUser SobUser类型，需要提交新的密码MD5值以及获取验证码的邮箱地址
• 返回：
  • 40000 操作失败，请看提示
  • 20000 密码修改完成

获取用户信息

• 接口：

/user/user_info/{userId}

• 方法：GET
• 参数：
  • userId 用户ID，path，必须
• 返回：
  • 40000 用户不存在
  • 20000 获取成功

更新用户信息

• 接口：

/user/user_info/{userId}

• 方法：PUT
• 参数
  • userId 用户ID，path 必须
  • sobUser SobUser类型、可经修改签名、用户名、头像
• 返回：
  • 40002 权限不足，只能修改自己账号的
  • 40002 账号未登录
  • 20000 修改成功

获取图灵验证码

• 接口

/user/utils/captcha

• 方法：GET
• 参数：无

检查邮箱验证码是否正确

• 接口

/user/utils/check_email_code

• 方法：GET
• 参数：
  • captchaCode string类型 图灵验证码 query 必须
  • email string类型 邮箱地址 query 必须
  • emailCode 邮箱验证码 string类型 query 必须
• 返回：
  • 40000 操作失败，具体请看信息
  • 20000 验证码正确

查询用户的token是否有

• 接口

/user/utils/check_token

• 方法：GET
• 参数：无
• 返回：
  • 40000 用户未登录
  • 20000 用户已登录，返回用户相关信息

检查邮箱地址是否有注册

• 接口

/user/utils/email

• 方法：GET
• 参数
  • email string 邮箱地址 query 必须
• 返回
  • 40000 邮箱未注册
  • 20000 邮箱已注册

获取扫码登录的二维码

• 接口

/user/utils/pc_login_qr_code

• 方法：GET
• 参数：无
• 返回：
  • code 为登录ID
  • url 为验证码的ID

检查用户名是否有注册

• 接口

/user/utils/user_name

• 方法：GET
• 参数：
  • userName 用户名 string query 必须
• 返回：
  • 40000 未注册
  • 20000 已经注册

发送邮箱验证码

• 接口

/user/utils/verify_code

• 方法：GET
• 参数：
  • captchaCode 图灵验证码 query 必须
  • email 邮箱地址 query 必须
  • type 类型 选填于（register，forget，update）注册、找回密码、更新密码
• 返回
  • 40000 操作失败，请看提示
  • 20000 验证码发送成功

门户接口

评论Bean类

Comment{
articleId	string
content	string
createTime	string($date-time)
id	string
parentContent	string
state	string
updateTime	string($date-time)
userAvatar	string
userId	string
userName	string
}

获取文章详情

• 接口

/portal/article/{articleId}

• 方法：GET
• 参数：
  • articleId 文章id，必须，path
• 返回
  • 40000 文章不存在
  • 20000 获取文章成功

获取文章分类列表

• 接口

/portal/article/categories

• 方法：GET
• 参数：无
• 返回：
  • 20000 获取分类成功

获取标签列表

• 接口

/portal/article/label/{size}

• 方法：GET
• 参数：
  • size 获取标签个数，必须，最大值为30
• 返回：
  • 20000 获取分类成功

根据分类获取文章内容

• 接口

/portal/article/list/{categoryId}/{page}/{size}

• 方法：GET
• 参数：
  • categoryId 分类ID path 必须
  • page 页码 path 必须
  • size 表示每一页的数量，最大值为30，必须
• 返回：
  • 20000 获取文章列表成功

获取最新文章列表

• 接口：

/portal/article/list/{page}/{size}

• 方法：GET
• 参数：
  • page 页码 必须 path
  • size 每页数量 必须 path

获取相关文章

• 接口

/portal/article/recommend/{articleId}/{size}

• 方法：GET
• 参数：
  • articleId 文章ID , 必须 path
  • size 获取推荐的数量 必须 path
• 返回：
  • 20000 获取推荐列表成功

获取置顶文章列表

• 接口

/portal/article/top

• 方法：GET
• 参数：无
• 返回：
  • 20000 获取置顶文章成功

提交文章评论

• 接口

/portal/comment

• 方法：POST
• 参数
  • comment Comment类型 body
    • articleId 文章ID 必须
    • content 评论内容 必须
    • parentContent 被回复的内容，选填
• 返回
  • 40002 账号未登录
  • 40000 操作失败，请看提示信息
  • 20000 评论成功

删除评论

• 接口

/portal/comment/{commentId}

• 方法：DELETE
• 参数：
  • commentId 评论id path 必须
• 返回：
  • 40002 账号未登录
  • 40000 评论不存在
  • 20000 删除评论成功
  • 40002 权限不足

获取文章的评论列表

• 接口

/portal/comment/list/{articleId}/{page}/{size}

• 方法：GET
• 参数
  • articleId 文章ID path 必须
  • page 页码 path 必须
  • size 每页数量 path 必须
• 返回：
  • 20000 获取评论列表成功

图片访问接口

一般来说，上传图片之类的会返回图片ID，通过此接口可以访问图片内容

• 接口

/portal/image/{imageId}

• 方法：GET
• 参数：
  • imageId 图片的ID，path 必须
• 返回：
  • 图片流

获取扫码登录的二维码图片

• 接口

/portal/image/qr-code/{code}

• 方法：GET
• 参数：
  • code 登录码 必须，请求登录二维码信息获得，前面接口
• 返回
  • 图片流

搜索内容

• 接口

/portal/search

• 方法：GET
• 参数：
  • categoryId 分类ID query 选填
  • keyword 关键字 query 必须
  • page 页码 query 必须
  • size 每页数量 query 必须
  • sort 排序方式，query 选填：根据时间的升序（1）和降序（2），根据浏览量的升序（3）和降序（4）
• 返回：
  • 40000 操作失败，请看信息
  • 20000 搜素成功

获取友情链接列表

• 接口

/portal/web_size_info/friend_link

• 方法：GET
• 参数：无
• 返回：
  • 20000 获取友情链接列表成功

获取首页轮播图

• 接口

/portal/web_size_info/loop

• 方法：GET
• 参数：无
• 返回：
  • 20000 获取轮播图列表成功