发表于： 2019-11-23 20:22:28
1 1217
今天做了什么
写接口文档, 不过还没写完整.
内容管理-文章管理
获取文章列表
请求地址:
请求参数:无
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | String | 标题 | ||
| image | String | 封面 | ||
| 分类 | ||||
| author | String | 作者 | ||
| introduction | String | 摘要 | ||
| collected_by | int | 收藏数 | ||
| liked_by | int | 点赞数 | ||
| status | int | 状态 |
文章点赞
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| sid | int | 学生id | ||
| aid | int | 文章id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
文章收藏
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| sid | int | 学生id | ||
| aid | int | 文章id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
文章详情-查看
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| aid | int | 文章id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | String | 标题 | ||
| 分类 | ||||
| image | String | 封面 | ||
| author | String | 作者 | ||
| introduction | String | 摘要 | ||
| content | 正文 |
文章详情-新增
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | String | 标题 | ||
| 分类 | ||||
| image | String | 封面 | ||
| author | String | 作者 | ||
| introduction | String | 摘要 | ||
| content | 正文 |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
文章详情-编辑
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | String | 标题 | ||
| 分类 | ||||
| image | String | 封面 | ||
| author | String | 作者 | ||
| introduction | String | 摘要 | ||
| content | 正文 |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
上架文章
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| aid | int | 文章id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
下架文章
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| aid | String | 文章id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
搜索文章
请求地址:请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | String | 标题 | ||
| author | String | 作者 | ||
| 分类 | ||||
| status | int | 状态 | ||
| liked_by_min | int | 点赞数下限 | ||
| like_by_max | int | 点赞数上限 | ||
| collected_by_min | int | 收藏数下限 | ||
| collected_by_max | int | 收藏数上限 |
返回参数:
data:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | String | 标题 | ||
| image | String | 封面 | ||
| 分类 | ||||
| author | String | 作者 | ||
| introduction | String | 摘要 | ||
| collected_by | int | 收藏数 | ||
| liked_by | int | 点赞数 | ||
| status | int | 状态 |
后台管理-账号管理
新增账户
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| 登录名 | ||||
| 手机号码 | ||||
| 密码 | ||||
| 密码确认 | ||||
| 角色 |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 信息 |
编辑账户
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| 登录名 | ||||
| 手机号码 | ||||
| 密码 | ||||
| 密码确认 | ||||
| 角色 |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 信息 |
删除账户
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| 账户id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 信息 |
搜索账户
请求地址:
后台管理-角色管理
新增角色
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| role | String | 角色名 | ||
| permission | List | 权限列表 |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
编辑角色
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| rid | int | 角色id | ||
| role | String | 角色名 | ||
| permission | List | 权限列表 |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
删除角色
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| rid | int | 角色id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
后台管理-模块管理
新增模块
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| name | String | 模块名称 | ||
| Menu Id | ? | |||
| module_url | String | URL地址 | ||
| parent_id | Long | 父模块ID |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
编辑模块
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| id | Long | 模块id | ||
| name | String | 模块名称 | ||
| Menu Id | ? | |||
| module_url | String | URL地址 | ||
| parent_id | Long | 父模块ID |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
删除模块
请求地址:
请求参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| id | Long | 模块id |
返回参数:
| 字段 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| code | int | 状态码 | ||
| message | String | 返回信息 |
收获
设计数据库表方面增加了经验.
问题
感觉动态查询不好写.
明天的计划
继续完成接口文档.
返回列表
评论