文章接口
1. 获取文章分类
接口地址:/home/article/type
响应示例:
有分类时:
json
{
"code": 1,
"msg": "获取成功",
"data": [
// 无分类时 无此响应字段
{
"alias": "gonggao", // 分类别名(英文标识)
"label": "公告" // 分类名称(显示名称)
}
]
}2. 获取文章列表
接口地址:/home/article/list
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| alias | String | 是 | 文章分类别名(从获取文章分类接口获取) |
| page | Integer | 否 | 页码,默认 1 |
| limit | Integer | 否 | 每页数量,默认 10 |
响应示例:
有文章时:
json
{
"code": 1,
"msg": "获取成功",
"data": {
"category": {
// 分类信息
"id": 2,
"pid": 0,
"name": "使用帮助",
"alias": "123",
"remark": "321",
"status": 1,
"create_at": "2025-11-23 14:34:38",
"update_at": "-0001-11-30 00:00:00",
"type": 1
},
"list": [
// 文章列表信息
{
"id": 2,
"cate_id": 2,
"title": "关于怎么充值",
"content": "<p>这样那样</p>",
"status": 1,
"views": 0,
"create_at": "2025-11-23 14:34:59",
"update_at": "-0001-11-30 00:00:00", // 更新时间,暂无用途
"top": 0 // 1置顶 0非置顶
}
],
"total": 1
}
}无文章时:
json
{
"code": 1,
"msg": "获取成功",
"data": {
"category": {
"id": 2,
"pid": 0,
"name": "帮助",
"alias": "faq",
"remark": "",
"status": 1,
"create_at": "2025-11-16 17:38:15",
"update_at": "-0001-11-30 00:00:00",
"type": 1
},
"list": [],
"total": 0
}
}错误响应示例:
json
{
"code": 0,
"msg": "分类不存在!"
}3. 获取文章详情
接口地址:/home/article/detail
认证:不需要
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | Integer | 是 | 文章 ID |
响应示例:
json
{
"code": 1,
"msg": "获取成功",
"data": {
"category": { // 当前分类信息
"id": 3,
"pid": 0,
"name": "常见问题",
"alias": "使用帮助",
"remark": "",
"status": 1,
"create_at": "2025-11-23 14:37:07",
"update_at": "-0001-11-30 00:00:00",
"type": 1
},
"detail": { // 当前文章信息
"id": 3,
"cate_id": 3,
"title": "使用帮助",
"content": "<p>4465445846485</p>", // 内容
"status": 1,
"views": 1,
"create_at": "2025-11-23 14:37:28",
"update_at": "-0001-11-30 00:00:00",
"top": 0
}
}
}错误响应示例:
json
{
"code": 0,
"msg": "文章不存在!"
}说明:
- 访问文章详情会自动增加浏览次数(views +1)
- 只能查询状态为 1(已发布)的文章
- 返回文章所属的分类信息
- 更新时间预留暂无用途,无需使用