118 lines
3.3 KiB
Markdown
118 lines
3.3 KiB
Markdown
# 公告管理使用说明
|
||
|
||
## 功能概述
|
||
|
||
公告管理模块提供了完整的公告信息管理功能，包括公告的创建、编辑、删除、启用/禁用等操作。
|
||
|
||
## 功能特性
|
||
|
||
- ✅ 公告列表查看（支持分页）
|
||
- ✅ 按标题/内容关键词搜索
|
||
- ✅ 按启用状态筛选
|
||
- ✅ 创建新公告
|
||
- ✅ 编辑现有公告
|
||
- ✅ 删除公告
|
||
- ✅ 一键启用/禁用公告
|
||
- ✅ 支持跳转链接设置
|
||
- ✅ 权限控制（管理员和代理商不同权限）
|
||
|
||
## 权限说明
|
||
|
||
### 管理员权限
|
||
- 查看公告列表
|
||
- 创建新公告
|
||
- 编辑现有公告
|
||
- 删除公告
|
||
- 启用/禁用公告
|
||
|
||
### 代理商权限
|
||
- 查看公告列表（只读）
|
||
|
||
## 使用步骤
|
||
|
||
### 1. 访问公告管理
|
||
- 登录管理后台
|
||
- 在左侧导航菜单中点击"公告管理"
|
||
|
||
### 2. 查看公告列表
|
||
- 公告列表显示所有公告信息
|
||
- 支持按关键词搜索（标题或内容）
|
||
- 支持按启用状态筛选
|
||
- 支持分页浏览
|
||
|
||
### 3. 创建新公告
|
||
1. 点击"新增公告"按钮
|
||
2. 填写公告信息：
|
||
- **标题**：必填，公告标题
|
||
- **内容**：必填，公告详细内容
|
||
- **跳转链接**：可选，点击公告后跳转的URL
|
||
- **状态**：选择是否启用
|
||
3. 点击"保存"完成创建
|
||
|
||
### 4. 编辑公告
|
||
1. 在公告列表中找到要编辑的公告
|
||
2. 点击"编辑"按钮
|
||
3. 修改公告信息
|
||
4. 点击"保存"完成修改
|
||
|
||
### 5. 删除公告
|
||
1. 在公告列表中找到要删除的公告
|
||
2. 点击"删除"按钮
|
||
3. 确认删除操作
|
||
|
||
### 6. 启用/禁用公告
|
||
- 在公告列表中，直接点击状态开关即可快速启用或禁用公告
|
||
- 只有启用的公告才会对用户可见
|
||
|
||
## 字段说明
|
||
|
||
| 字段 | 类型 | 必填 | 说明 |
|
||
|------|------|------|------|
|
||
| 标题 | 文本 | 是 | 公告标题，用于列表显示 |
|
||
| 内容 | 文本 | 是 | 公告详细内容 |
|
||
| 跳转链接 | URL | 否 | 点击公告后跳转的链接地址 |
|
||
| 状态 | 布尔 | 是 | 是否启用，只有启用的公告用户才能看到 |
|
||
|
||
## 注意事项
|
||
|
||
1. **权限控制**：只有具备相应权限的用户才能进行相应操作
|
||
2. **数据验证**：标题和内容为必填字段
|
||
3. **URL验证**：跳转链接必须是有效的URL格式（以http://或https://开头）
|
||
4. **状态控制**：只有启用的公告才会在前端显示给用户
|
||
5. **操作记录**：所有操作都会记录创建时间和更新时间
|
||
|
||
## API接口
|
||
|
||
公告管理使用以下API接口：
|
||
|
||
- `GET /api/admin/announcement/list` - 获取公告列表
|
||
- `POST /api/admin/announcement` - 创建公告
|
||
- `PUT /api/admin/announcement/{id}` - 更新公告
|
||
- `DELETE /api/admin/announcement/{id}` - 删除公告
|
||
- `PUT /api/admin/announcement/{id}/enabled` - 更新启用状态
|
||
- `GET /api/admin/announcement/enabled` - 获取启用的公告
|
||
|
||
详细的API文档请参考项目根目录的接口文档。
|
||
|
||
## 故障排除
|
||
|
||
### 常见问题
|
||
|
||
1. **无法访问公告管理页面**
|
||
- 检查用户是否有相应权限
|
||
- 确认已正确登录
|
||
|
||
2. **创建公告失败**
|
||
- 检查标题和内容是否已填写
|
||
- 检查跳转链接格式是否正确
|
||
|
||
3. **状态切换失败**
|
||
- 检查网络连接
|
||
- 确认用户有编辑权限
|
||
|
||
4. **搜索无结果**
|
||
- 检查搜索关键词是否正确
|
||
- 尝试重置搜索条件
|
||
|
||
如有其他问题，请联系系统管理员。
|