Skip to content

通知公告接口

接口列表

接口方法说明
/api/v1/noticesGET获取通知列表
/api/v1/notices/{id}GET获取通知详情
/api/v1/noticesPOST发布通知
/api/v1/notices/{id}PUT修改通知
/api/v1/notices/{id}DELETE删除通知
/api/v1/notices/{id}/readPOST标记为已读

获取通知列表

http
GET /api/v1/notices?pageNum=1&pageSize=10&type=1&status=1
Authorization: Bearer {accessToken}

查询参数

参数类型必填说明
pageNumnumber页码(默认 1)
pageSizenumber每页条数(默认 10)
titlestring标题(模糊查询)
typenumber类型(1 通知,2 公告)
statusnumber状态(1 正常,0 关闭)

响应示例

json
{
  "code": "00000",
  "message": "成功",
  "data": {
    "total": 12,
    "list": [
      {
        "id": 1,
        "title": "系统升级通知",
        "content": "系统将于本周六 22:00 进行升级...",
        "type": 1,
        "status": 1,
        "createTime": "2024-01-15 10:30:00",
        "createBy": "管理员"
      }
    ]
  }
}

获取通知详情

http
GET /api/v1/notices/1
Authorization: Bearer {accessToken}

响应示例

json
{
  "code": "00000",
  "message": "成功",
  "data": {
    "id": 1,
    "title": "系统升级通知",
    "content": "系统将于本周六 22:00 进行升级...",
    "type": 1,
    "status": 1,
    "createTime": "2024-01-15 10:30:00",
    "createBy": "管理员",
    "readCount": 156,
    "isRead": true
  }
}

发布通知

http
POST /api/v1/notices
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "title": "系统升级通知",
  "content": "系统将于本周六 22:00 进行升级维护...",
  "type": 1,
  "status": 1
}

标记为已读

http
POST /api/v1/notices/1/read
Authorization: Bearer {accessToken}

通知类型

说明
1通知
2公告

通知状态

说明
1正常(显示)
0关闭(隐藏)

权限要求

操作权限标识
查看列表sys:notice:list
发布通知sys:notice:add
修改通知sys:notice:edit
删除通知sys:notice:delete

实时推送

启用 SSE 后,新通知会实时推送到前端:

typescript
// SSE 事件格式
{
  event: 'notice',
  data: {
    id: 1,
    title: '系统升级通知',
    type: 1
  }
}

基于 MIT 许可发布 · 由 ❤️ 和 ☕ 驱动 · 支持作者