docs: 添加功能清单和 AI 审核 API 文档
- 新增 FEATURES.md 功能清单 - 新增 AI_AUDIT_API.md API 文档 - 记录所有已完成功能 - 记录 AI 审核测试结果
This commit is contained in:
maoshen
209
AI_AUDIT_API.md
Normal file
209
AI_AUDIT_API.md
Normal file
@@ -0,0 +1,209 @@
|
||||
# AI 审核 API 文档
|
||||
|
||||
## 概述
|
||||
|
||||
AI 审核模块提供自动内容审核功能，支持文章、评论、特色服务的自动审核。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- ✅ 敏感词检测
|
||||
- ✅ 广告内容检测
|
||||
- ✅ 内容质量评估
|
||||
- ✅ 自动审核决策
|
||||
|
||||
## API 端点
|
||||
|
||||
### 1. 审核文章
|
||||
|
||||
**端点**: `POST /api/audit/article/`
|
||||
|
||||
**认证**: 需要 JWT Token
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"title": "文章标题",
|
||||
"content": "文章内容"
|
||||
}
|
||||
```
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
{
|
||||
"approved": true,
|
||||
"reason": "审核通过",
|
||||
"details": {
|
||||
"quality_score": 100
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**拒绝示例**:
|
||||
```json
|
||||
{
|
||||
"approved": false,
|
||||
"reason": "内容包含敏感词：暴力",
|
||||
"details": {
|
||||
"sensitive_words": ["暴力"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. 审核评论
|
||||
|
||||
**端点**: `POST /api/audit/comment/`
|
||||
|
||||
**认证**: 需要 JWT Token
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"content": "评论内容"
|
||||
}
|
||||
```
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
{
|
||||
"approved": true,
|
||||
"reason": "审核通过"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3. 审核特色服务
|
||||
|
||||
**端点**: `POST /api/audit/service/`
|
||||
|
||||
**认证**: 需要 JWT Token
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"name": "服务名称",
|
||||
"description": "服务描述"
|
||||
}
|
||||
```
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
{
|
||||
"approved": true,
|
||||
"reason": "审核通过"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 4. 审核服务状态
|
||||
|
||||
**端点**: `GET /api/audit/status/`
|
||||
|
||||
**认证**: 需要 JWT Token
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
{
|
||||
"status": "active",
|
||||
"service": "AI Audit Service",
|
||||
"version": "1.0.0",
|
||||
"features": [
|
||||
"敏感词检测",
|
||||
"广告检测",
|
||||
"内容质量评估"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 测试用例
|
||||
|
||||
| 测试 | 输入 | 预期结果 | 状态 |
|
||||
|------|------|----------|------|
|
||||
| 文章审核 (正常) | 北京旅游攻略 | ✅ 通过 | ✅ |
|
||||
| 文章审核 (敏感词) | 包含暴力内容 | ❌ 拒绝 | ✅ |
|
||||
| 评论审核 (广告) | 加微信 123456 | ❌ 拒绝 | ✅ |
|
||||
| 服务审核 (正常) | 老北京烤鸭店 | ✅ 通过 | ✅ |
|
||||
| 内容质量 (太短) | 好 | ❌ 拒绝 | ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 敏感词库
|
||||
|
||||
当前敏感词库包含：
|
||||
- 暴力、恐怖、色情、赌博、毒品
|
||||
- 诈骗、传销、假币、枪支、弹药
|
||||
|
||||
## 广告关键词
|
||||
|
||||
- 加微信、QQ 群、联系电话、手机号
|
||||
- www.、.com、.cn、http
|
||||
|
||||
## 内容质量规则
|
||||
|
||||
- 最小长度：10 个字符
|
||||
- 重复字符检测
|
||||
- 中文内容比例检查
|
||||
|
||||
---
|
||||
|
||||
## 集成示例
|
||||
|
||||
### Python 示例
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
TOKEN = 'your_jwt_token'
|
||||
HEADERS = {
|
||||
'Authorization': f'Bearer {TOKEN}',
|
||||
'Content-Type': 'application/json'
|
||||
}
|
||||
|
||||
# 审核文章
|
||||
response = requests.post(
|
||||
'http://cssc.datalibstar.com/api/audit/article/',
|
||||
headers=HEADERS,
|
||||
json={
|
||||
'title': '北京旅游攻略',
|
||||
'content': '北京是中国的首都...'
|
||||
}
|
||||
)
|
||||
result = response.json()
|
||||
print(result['approved']) # True/False
|
||||
```
|
||||
|
||||
### JavaScript 示例
|
||||
|
||||
```javascript
|
||||
const TOKEN = 'your_jwt_token';
|
||||
|
||||
// 审核文章
|
||||
fetch('http://cssc.datalibstar.com/api/audit/article/', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Authorization': `Bearer ${TOKEN}`,
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
title: '北京旅游攻略',
|
||||
content: '北京是中国的首都...'
|
||||
})
|
||||
})
|
||||
.then(res => res.json())
|
||||
.then(data => {
|
||||
console.log(data.approved); // True/False
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 部署状态
|
||||
|
||||
- ✅ 本地开发环境
|
||||
- ✅ 云服务器 (cssc.datalibstar.com)
|
||||
- ✅ 所有测试用例通过
|
||||
122
FEATURES.md
Normal file
122
FEATURES.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# 城市手册项目 - 功能清单
|
||||
|
||||
## ✅ 已完成功能
|
||||
|
||||
### 1. 基础框架
|
||||
- [x] Django 4.2 后端框架
|
||||
- [x] React 18 前端框架
|
||||
- [x] PostgreSQL 数据库
|
||||
- [x] Docker + Docker Compose 部署
|
||||
- [x] Nginx 反向代理
|
||||
- [x] JWT 认证系统
|
||||
|
||||
### 2. 用户系统
|
||||
- [x] 用户注册/登录
|
||||
- [x] JWT Token 认证
|
||||
- [x] 个人中心
|
||||
- [x] 用户角色 (普通用户/版主/AI 审核员/管理员)
|
||||
|
||||
### 3. 版块管理
|
||||
- [x] 5 级行政区划 (省→市→县→乡镇→村)
|
||||
- [x] 34 个省级行政区数据
|
||||
- [x] 树形结构查询
|
||||
- [x] 版块层级导航
|
||||
|
||||
### 4. 地图导航
|
||||
- [x] 中国地图组件 (react-simple-maps)
|
||||
- [x] 省份点击跳转
|
||||
- [x] 悬停提示
|
||||
- [x] 热力图显示
|
||||
|
||||
### 5. 内容管理
|
||||
- [x] 文章 CRUD
|
||||
- [x] 特色服务 CRUD (7 大分类)
|
||||
- [x] 内容审核流程 (版主 + AI)
|
||||
- [x] 发布状态管理
|
||||
|
||||
### 6. 交互功能
|
||||
- [x] 评论系统
|
||||
- [x] 评分系统 (1-5 星)
|
||||
- [x] 点赞功能
|
||||
- [x] 收藏功能
|
||||
|
||||
### 7. 版主系统
|
||||
- [x] 版主申请
|
||||
- [x] 军衔体系 (将军/校官/尉官/士兵)
|
||||
- [x] 权限管理
|
||||
- [x] 支持人数统计
|
||||
|
||||
### 8. AI 审核 🔥
|
||||
- [x] 敏感词检测
|
||||
- [x] 广告内容检测
|
||||
- [x] 内容质量评估
|
||||
- [x] 文章审核 API
|
||||
- [x] 评论审核 API
|
||||
- [x] 服务审核 API
|
||||
- [x] 所有测试用例通过 ✅
|
||||
|
||||
---
|
||||
|
||||
## 🚧 进行中功能
|
||||
|
||||
| 功能 | 优先级 | 进度 |
|
||||
|------|--------|------|
|
||||
| 搜索功能 | 中 | 0% |
|
||||
| Django Admin 自定义 | 中 | 0% |
|
||||
| 图片上传 | 中 | 0% |
|
||||
| 分享功能 | 低 | 0% |
|
||||
|
||||
---
|
||||
|
||||
## 📋 待开发功能
|
||||
|
||||
- [ ] 数据抓取工具
|
||||
- [ ] 商家入驻功能
|
||||
- [ ] 多语言支持
|
||||
- [ ] 移动 App
|
||||
- [ ] 高级统计分析
|
||||
|
||||
---
|
||||
|
||||
## 📊 项目统计
|
||||
|
||||
| 指标 | 数量 |
|
||||
|------|------|
|
||||
| Django Apps | 7 个 |
|
||||
| 数据库模型 | 12 个 |
|
||||
| API 端点 | 50+ |
|
||||
| 前端页面 | 10+ |
|
||||
| 代码行数 | 5000+ |
|
||||
| Git 提交 | 10+ |
|
||||
|
||||
---
|
||||
|
||||
## 🌐 访问地址
|
||||
|
||||
- **网站**: http://cssc.datalibstar.com
|
||||
- **Admin**: http://cssc.datalibstar.com/admin/
|
||||
- **API**: http://cssc.datalibstar.com/api/
|
||||
- **GraphQL**: http://cssc.datalibstar.com/graphql/
|
||||
|
||||
**管理员账号**: `admin` / `Admin123!`
|
||||
|
||||
---
|
||||
|
||||
## 📅 开发日志
|
||||
|
||||
### 2026-04-14
|
||||
- ✅ 修复 nginx 静态资源配置
|
||||
- ✅ 部署到云服务器
|
||||
- ✅ 实现 AI 审核模块
|
||||
- ✅ 所有 AI 审核测试通过
|
||||
|
||||
### 2026-04-13
|
||||
- ✅ 添加中国地图导航
|
||||
- ✅ 导入 34 个省份数据
|
||||
- ✅ 修复前端构建问题
|
||||
|
||||
### 2026-04-10
|
||||
- ✅ 完成基础框架搭建
|
||||
- ✅ 实现所有数据库模型
|
||||
- ✅ 实现所有 API 端点
|
||||
- ✅ 实现前端核心页面
|
||||
Reference in New Issue
Block a user