aiotagro/xlxumu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: 重构数据库配置为SQLite开发环境并移除冗余文档

Browse Source
This commit is contained in:
aiotagro
2025-09-21 15:16:48 +08:00
parent d207610009
commit 3c8648a635
259 changed files with 88239 additions and 8379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

325
docs/design/api/dashboard.md
View File

@@ -1,325 +0,0 @@
# 大屏可视化系统 API 文档 (v1.0.0)
## 1. 接口概述
### 1.1 功能范围
- 产业数据概览展示
- 实时监控数据推送
- 历史数据查询分析
- 地图区域数据展示
### 1.2 基础路径
`/api/v1/dashboard`
### 1.3 权限控制
- 公开接口（无需认证）：数据查询和展示
- 管理接口（需要认证）：数据配置和管理
### 1.4 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
## 2. 接口明细
### 2.1 获取实时数据
```
GET /realtime
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| 无参数 | | | |
**响应示例**:
```json
{
"status": "success",
"data": {
"timestamp": "2023-08-19T10:30:00Z",
"total_cattle": 128456,
"total_farms": 1245,
"annual_output_value": 2860000000,
"total_transaction": 1520000000
}
}
```
### 2.2 WebSocket实时数据推送
```
WebSocket /ws
```
**推送数据格式**:
```json
{
"type": "realtime_update",
"data": {
"timestamp": "2023-08-19T10:30:00Z",
"total_cattle": 128456,
"total_farms": 1245,
"annual_output_value": 2860000000,
"total_transaction": 1520000000
}
}
```
### 2.3 获取历史数据
```
GET /history
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| start_date | string | 否 | 开始日期(YYYY-MM-DD)|
| end_date | string | 否 | 结束日期(YYYY-MM-DD)|
| type | string | 是 | 数据类型 |
**响应示例**:
```json
{
"status": "success",
"data": {
"items": [
{
"date": "2023-01",
"value": 8200
},
{
"date": "2023-02",
"value": 9100
}
],
"total": 12,
"start_date": "2023-01-01",
"end_date": "2023-12-31"
}
}
```
### 2.4 获取区域地图数据
```
GET /map/regions
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| 无参数 | | | |
**响应示例**:
```json
{
"status": "success",
"data": {
"regions": [
{
"id": "xlg",
"name": "锡林浩特市",
"coordinates": [116.093, 43.946],
"cattle_count": 25600,
"farm_count": 120,
"output_value": 650000000
},
{
"id": "dwq",
"name": "东乌旗",
"coordinates": [116.980, 45.514],
"cattle_count": 18500,
"farm_count": 95,
"output_value": 480000000
}
],
"total": 12
}
}
```
### 2.5 获取指定区域详细数据
```
GET /map/region/{regionId}
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| regionId | string | 是 | 区域ID |
**响应示例**:
```json
{
"status": "success",
"data": {
"region": {
"id": "xlg",
"name": "锡林浩特市",
"coordinates": [116.093, 43.946],
"cattle_count": 25600,
"farm_count": 120,
"output_value": 650000000,
"trend": "up"
},
"farms": [
{
"id": "FARM001",
"name": "锡林浩特市第一牧场",
"coordinates": [116.120, 43.950],
"cattle_count": 2450,
"output_value": 62000000
}
]
}
}
```
## 3. 版本历史
### v1.0.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完成基础接口定义
### 2.6 获取大屏配置
```
GET /config
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| 无参数 | | | |
**响应示例**:
```json
{
"status": "success",
"data": {
"layout": "grid",
"theme": "dark",
"refresh_interval": 30,
"charts": [
{
"id": "cattle_count",
"type": "line",
"title": "牛只数量趋势",
"position": "top-left"
},
{
"id": "transaction_volume",
"type": "bar",
"title": "交易量统计",
"position": "top-right"
}
]
}
}
```
### 2.7 更新大屏配置
```
PUT /config
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-----------------|--------|------|--------------------|
| layout | string | 是 | 布局方式 |
| theme | string | 是 | 主题 |
| refresh_interval| number | 是 | 刷新间隔(秒) |
| charts | array | 是 | 图表配置 |
**响应示例**:
```json
{
"status": "success",
"data": {
"message": "配置更新成功"
}
}
```
## 5. 数据格式
### 5.1 产业概览数据
```json
{
"total_cattle": 128456,
"total_farms": 1245,
"annual_output_value": 2860000000,
"total_transaction": 1520000000,
"growth_rate": 5.2
}
```
### 5.2 养殖监控数据
```json
{
"farm_id": "FARM001",
"temperature": 22.5,
"humidity": 65,
"cattle_count": 245,
"feed_consumption": 1200
}
```
### 5.3 金融服务数据
```json
{
"loan_amount": 8600000,
"insurance_policies": 12450,
"claim_amount": 245000,
"approval_rate": 92.5
}
```
### 5.4 交易统计数据
```json
{
"daily_transactions": 125,
"average_price": 18500,
"regional_distribution": [
{
"region": "东乌旗",
"count": 1200
}
]
}
```
## 6. 错误处理
### 6.1 错误响应格式
```json
{
"error": {
"code": "DASHBOARD_001",
"message": "获取数据失败",
"details": "数据库连接异常"
}
}
```
### 6.2 常见错误码
- `DASHBOARD_001`: 数据获取失败
- `DASHBOARD_002`: 参数错误
- `DASHBOARD_003`: 权限不足
- `DASHBOARD_004`: 系统内部错误
## 7. 权限说明
大屏可视化系统接口需要以下权限：
- `dashboard:view`: 查看大屏数据权限
- `dashboard:config`: 配置大屏权限
## 8. 注意事项
1. 大屏可视化系统主要面向内部管理使用，需要相应权限才能访问
2. 实时数据推送通过WebSocket实现，需要保持长连接
3. 历史数据支持分页查询，避免一次性加载大量数据
4. 所有接口均采用HTTPS加密传输

139
docs/design/api/farming.md
View File

@@ -1,139 +0,0 @@
# 养殖管理系统 API 文档 (v1.1.0)
## 1. 接口概述
### 1.1 功能范围
- 牛只档案管理
- 饲喂记录管理
- 防疫管理
- 繁殖管理
- 环境监测
### 1.2 基础路径
`/api/v1/farming`
### 1.3 技术栈
- **后端**: Java Spring Boot + Spring Cloud (farming-service, 端口: 8081)
- **数据库**: MySQL
- **缓存**: Redis
- **API文档**: Swagger
### 1.4 权限控制
- 公开接口（无需认证）：数据查询
- 管理接口（需要认证）：数据录入和管理
- 系统接口（高级权限）：批量操作和配置
### 1.5 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
## 2. 接口明细
### 2.1 添加牛只
```
POST /cattles
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|--------------|--------|------|--------------------|
| ear_tag | string | 是 | 耳标号(唯一) |
| breed | string | 是 | 品种 |
| birth_date | string | 是 | 出生日期(YYYY-MM-DD)|
| gender | string | 是 | 性别(公/母) |
| weight | number | 否 | 体重(kg) |
**响应示例**:
```json
{
"status": "success",
"data": {
"id": "CATTLE001",
"ear_tag": "NM000001",
"created_at": "2024-01-20T10:00:00Z"
},
"timestamp": "2024-01-20T10:00:00Z"
}
```
### 2.2 批量导入牛只
```
POST /cattles/batch
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|--------------|--------|------|--------------------|
| file | file | 是 | Excel文件 |
**响应示例**:
```json
{
"status": "success",
"data": {
"imported_count": 50,
"failed_count": 2,
"failed_items": [
{
"row": 25,
"error": "耳标号格式错误"
}
]
},
"timestamp": "2024-01-20T10:00:00Z"
}
```
### 2.3 添加防疫记录
```
POST /vaccinations
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|--------------|--------|------|--------------------|
| cattle_id | string | 是 | 牛只ID |
| vaccine_type | string | 是 | 疫苗类型 |
| date | string | 是 | 接种日期(YYYY-MM-DD)|
| dosage | number | 否 | 剂量(ml) |
| veterinarian | string | 否 | 兽医姓名 |
**响应示例**:
```json
{
"status": "success",
"data": {
"id": "VACC001",
"cattle_id": "CATTLE001",
"vaccine_type": "口蹄疫",
"created_at": "2024-01-20T10:30:00Z"
},
"timestamp": "2024-01-20T10:30:00Z"
}
```
## 3. 数据规范
- 耳标号格式：省简称+6位数字(如NM000001)
- 疫苗记录保留至少5年
- 敏感数据需RSA加密传输
- 日期格式：YYYY-MM-DD
- 时间格式：YYYY-MM-DDTHH:mm:ssZ
## 4. 版本历史
### v1.1.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完善养殖管理接口定义
- 新增: Java后端技术栈说明
- 新增: timestamp字段
### v1.0.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完成基础接口定义

133
docs/design/api/finance.md
View File

@@ -1,133 +0,0 @@
# 金融业务系统 API 文档 (v1.1.0)
## 1. 接口概述
### 1.1 功能范围
- 贷款申请
- 保险购买
- 理赔处理
- 贷款审批
### 1.2 基础路径
`/api/v1/[系统名称]`
### 1.3 权限控制
- 公开接口（无需认证）：数据查询
- 管理接口（需要认证）：数据管理
- 系统接口（高级权限）：配置管理
### 1.4 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
`/api/v1/finance`
## 2. 接口明细
### 2.1 贷款申请
```
POST /loans
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|-----------------|---------|------|--------------------|
| farmer_id | number | 是 | 牧户ID |
| amount | number | 是 | 申请金额(元) |
| collateral_type | string | 是 | 抵押物类型 |
| term | number | 是 | 贷款期限(月) |
| interest_rate | number | 是 | 年利率(%) |
**响应示例**:
```json
{
"status": "success",
"data": {
"loan_id": "loan_001",
"farmer_id": 1001,
"amount": 50000,
"collateral_type": "牛只",
"term": 12,
"interest_rate": 4.35,
"monthly_payment": 4260.25,
"application_date": "2024-01-20T10:00:00Z",
"status": "审批中"
}
}
```
### 2.2 贷款审批状态查询
```
GET /loans/:id/status
```
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| id | string | 是 | 贷款ID |
**响应示例**:
```json
{
"status": "success",
"data": {
"loan_id": "loan_001",
"status": "已批准",
"approval_date": "2024-01-21T10:00:00Z",
"approved_amount": 50000,
"approver": "审批员001",
"next_payment_date": "2024-02-20T10:00:00Z"
}
}
```
### 2.3 保险购买
```
POST /insurances
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|-----------------|---------|------|--------------------|
| farmer_id | number | 是 | 牧户ID |
| cattle_id | string | 是 | 牛只ID |
| insurance_type | string | 是 | 保险类型 |
| premium | number | 是 | 保费(元) |
**响应示例**:
```json
{
"status": "success",
"data": {
"insurance_id": "ins_001",
"farmer_id": 1001,
"cattle_id": "cattle_123",
"insurance_type": "疾病保险",
"premium": 500,
"coverage_amount": 10000,
"effective_date": "2024-01-20T10:00:00Z",
"expiry_date": "2025-01-20T10:00:00Z",
"policy_number": "POL-20240120-001"
}
}
```
## 3. 风控规则
- 单笔贷款金额 ≤ 牧户资产总额的50%
- 理赔申请需在灾害发生后30天内提交
- 敏感数据需RSA加密传输
## 4. 权限控制
- 贷款申请：牧户
- 贷款审批：银行管理员
- 保险购买：牧户
## 3. 版本历史
### v1.0.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完成基础接口定义

126
docs/design/api/government.md
View File

@@ -1,126 +0,0 @@
# 政府监管系统 API 文档 (v1.1.0)
## 1. 接口概述
### 1.1 功能范围
- 防疫任务下发
- 补贴发放
- 检疫监管
- 任务状态跟踪
### 1.2 基础路径
`/api/v1/[系统名称]`
### 1.3 权限控制
- 公开接口（无需认证）：数据查询
- 管理接口（需要认证）：数据管理
- 系统接口（高级权限）：配置管理
### 1.4 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
`/api/v1/gov`
## 2. 接口明细
### 2.1 创建防疫任务
```
POST /quarantines
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|---------------|--------|------|--------------------|
| location | string | 是 | GPS坐标(纬度,经度)|
| inspector_id | number | 是 | 检疫员ID |
| deadline | string | 是 | 截止日期(YYYY-MM-DD)|
| task_type | string | 是 | 任务类型(常规/紧急)|
| priority | number | 否 | 优先级(1-5) |
**响应示例**:
```json
{
"status": "success",
"data": {
"task_id": "task_001",
"location": "39.9042,116.4074",
"inspector_id": 1001,
"deadline": "2024-01-25",
"task_type": "紧急",
"priority": 1,
"created_at": "2024-01-20T10:00:00Z"
}
}
```
### 2.2 防疫任务状态查询
```
GET /quarantines/:id/status
```
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| id | string | 是 | 任务ID |
**响应示例**:
```json
{
"status": "success",
"data": {
"task_id": "task_001",
"status": "进行中",
"progress": 50,
"inspector": "张三",
"start_time": "2024-01-20T10:00:00Z",
"estimated_completion": "2024-01-22T10:00:00Z"
}
}
```
### 2.3 检疫监管
```
POST /inspections
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|---------------|--------|------|--------------------|
| cattle_id | string | 是 | 牛只ID |
| inspector_id | number | 是 | 检疫员ID |
| result | string | 是 | 检疫结果(合格/不合格)|
**响应示例**:
```json
{
"status": "success",
"data": {
"inspection_id": "insp_001",
"cattle_id": "cattle_123",
"inspector_id": 1001,
"result": "合格",
"inspection_time": "2024-01-20T10:00:00Z",
"certificate_number": "CERT-20240120-001"
}
}
```
## 3. 审计要求
- 所有操作记录操作人IP和时间
- 敏感数据需RSA加密传输
## 4. 权限控制
- 防疫任务下发：政府管理员
- 检疫监管：检疫员
- 补贴发放：财务人员
## 3. 版本历史
### v1.0.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完成基础接口定义

156
docs/design/api/trade.md
View File

@@ -1,156 +0,0 @@
# 交易系统 API 文档 (v1.1.0)
## 1. 接口概述
### 1.1 功能范围
- 商品发布/下架
- 订单创建/支付
- 物流跟踪
- 订单状态查询
### 1.2 基础路径
`/api/v1/[系统名称]`
### 1.3 权限控制
- 公开接口（无需认证）：数据查询
- 管理接口（需要认证）：数据管理
- 系统接口（高级权限）：配置管理
### 1.4 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
`/api/v1/trades`
## 2. 接口明细
### 2.1 商品发布
```
POST /products
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|--------------|--------|------|--------------------|
| name | string | 是 | 商品名称 |
| price | number | 是 | 价格(元) |
| stock | number | 是 | 库存数量 |
| category | string | 是 | 商品分类 |
**响应示例**:
```json
{
"status": "success",
"data": {
"product_id": "prod_001",
"name": "优质牛肉",
"price": 98.5,
"stock": 100,
"category": "生鲜",
"seller_id": "seller_001",
"created_at": "2024-01-20T10:00:00Z",
"status": "上架中"
}
}
```
### 2.2 创建订单
```
POST /orders
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|--------------|--------|------|--------------------|
| product_id | number | 是 | 商品ID |
| quantity | number | 是 | 购买数量 |
| address_id | number | 是 | 收货地址ID |
| payment_method | string | 是 | 支付方式(微信/支付宝)|
| coupon_code | string | 否 | 优惠券码 |
**响应示例**:
```json
{
"status": "success",
"data": {
"order_id": "order_001",
"product_id": "prod_001",
"quantity": 2,
"total_amount": 197.0,
"discount_amount": 0.0,
"final_amount": 197.0,
"payment_method": "微信支付",
"order_status": "待支付",
"created_at": "2024-01-20T10:00:00Z",
"payment_expiry": "2024-01-20T10:30:00Z"
}
}
```
### 2.3 物流跟踪
```
GET /logistics/:order_id
```
**请求参数**:
| 参数 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| order_id | string | 是 | 订单ID |
**响应示例**:
```json
{
"status": "success",
"data": {
"order_id": "order_001",
"logistics": [
{
"tracking_number": "SF1234567890",
"status": "已发货",
"current_location": "北京市朝阳区",
"estimated_delivery": "2024-01-22T10:00:00Z",
"history": [
{
"time": "2024-01-20T10:00:00Z",
"status": "商家已接单",
"location": "北京市朝阳区"
},
{
"time": "2024-01-20T12:00:00Z",
"status": "已发货",
"location": "北京市朝阳区"
}
]
}
]
}
}
```
## 3. 状态流转
```mermaid
stateDiagram
[*] --> 待支付
待支付 --> 已支付: 支付成功
已支付 --> 配送中: 商家发货
配送中 --> 已完成: 确认收货
```
## 4. 安全要求
- 支付接口需HTTPS加密
- 敏感数据需RSA加密传输
## 5. 权限控制
- 商品发布：商户
- 订单创建：用户
- 物流跟踪：用户/商户
## 3. 版本历史
### v1.0.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完成基础接口定义

108
docs/design/api/user-center.md
View File

@@ -1,108 +0,0 @@
# 用户中心系统 API 文档 (v1.1.0)
## 1. 接口概述
### 1.1 功能范围
- 用户注册/登录/注销
- 个人信息管理
- 权限控制
### 1.2 基础路径
`/api/v1/users`
### 1.3 技术栈
- **后端**: Java Spring Boot + Spring Cloud (user-center-service, 端口: 8082)
- **数据库**: MySQL
- **缓存**: Redis
- **API文档**: Swagger
### 1.4 权限控制
- 公开接口（无需认证）：数据查询
- 管理接口（需要认证）：数据管理
- 系统接口（高级权限）：配置管理
### 1.5 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
## 2. 接口明细
### 2.1 用户注册
```
POST /register
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|------------|--------|------|----------------|
| username | string | 是 | 4-20位字母数字 |
| password | string | 是 | 6-20位含大小写 |
| phone | string | 是 | 11位手机号 |
**响应示例**:
```json
{
"status": "success",
"data": {
"user_id": "user_001",
"username": "testuser",
"phone": "13800138000",
"created_at": "2024-01-20T10:00:00Z"
},
"timestamp": "2024-01-20T10:00:00Z"
}
```
### 2.2 用户登录
```
POST /login
```
**请求参数**:
| 字段 | 类型 | 必填 | 说明 |
|------------|--------|------|----------------|
| username | string | 是 | 用户名 |
| password | string | 是 | 密码 |
**响应示例**:
```json
{
"status": "success",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"user_info": {
"user_id": "user_001",
"username": "testuser",
"roles": ["user"]
},
"expires_in": 86400
},
"timestamp": "2024-01-20T10:00:00Z"
}
```
## 3. 状态码规范
| 代码 | 说明 |
|------|----------------|
| 200 | 成功 |
| 400 | 参数校验失败 |
| 401 | 认证失败 |
## 4. 版本历史
### v1.1.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完善用户中心接口定义
- 新增: Java后端技术栈说明
- 新增: timestamp字段
### v1.0.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完成基础接口定义

203
docs/design/api/website.md
View File

@@ -1,203 +0,0 @@
# 官网 API 文档 (v1.1.0)
## 1. 接口概述
### 1.1 功能范围
- 新闻资讯管理
- 平台数据展示
- 用户留言处理
- 平台信息配置
- 管理员认证
### 1.2 基础路径
`/api/v1/website`
### 1.3 权限控制
- 公开接口（无需认证）：新闻列表、数据展示、留言提交
- 管理接口（需要认证）：新闻管理、留言处理、配置管理
- 认证接口：管理员登录
### 1.4 全局错误码
| 状态码 | 说明 |
|--------|--------------------|
| 400 | 请求参数无效 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
## 2. 接口明细
### 2.1 获取新闻列表
```
GET /news
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| page | number | 否 | 页码(默认1) |
| limit | number | 否 | 每页数量(默认10) |
| category | string | 否 | 分类筛选 |
**响应示例**:
```json
{
"status": "success",
"data": {
"items": [
{
"id": 1,
"title": "锡林郭勒盟出台畜牧业数字化发展三年规划",
"summary": "规划提出到2027年实现全盟畜牧业数字化覆盖率90%以上",
"category": "政策解读",
"publish_time": "2025-08-15T10:00:00Z",
"image_url": "/images/news-1.jpg"
}
],
"total": 100,
"page": 1,
"limit": 10
}
}
```
### 2.2 获取新闻详情
```
GET /news/{id}
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| id | number | 是 | 新闻ID |
**响应示例**:
```json
{
"status": "success",
"data": {
"id": 1,
"title": "锡林郭勒盟出台畜牧业数字化发展三年规划",
"content": "详细新闻内容...",
"category": "政策解读",
"publish_time": "2025-08-15T10:00:00Z",
"author": "管理员",
"views": 1250
}
}
```
### 2.3 获取统计数据
```
GET /statistics
```
**请求参数**:
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| 无参数 | | | |
**响应示例**:
```json
{
"status": "success",
"data": {
"livestock_count": {
"cattle": 1200000,
"sheep": 850000,
"horse": 320000,
"camel": 80000
},
"forage_data": {
"production": [12, 19, 15, 22, 28, 35],
"price": [1800, 1750, 1850, 1900, 1950, 2000]
}
}
}
```
### 2.4 提交留言
```
POST /messages
```
**请求参数**:
| 字段名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| name | string | 是 | 姓名 |
| email | string | 是 | 邮箱 |
| phone | string | 否 | 电话 |
| content | string | 是 | 留言内容 |
**响应示例**:
```json
{
"status": "success",
"data": {
"message": "留言提交成功，我们会尽快回复您",
"message_id": "MSG001"
}
}
```
### 2.5 管理员登录
```
POST /auth/login
```
**请求参数**:
| 字段名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| username | string | 是 | 用户名 |
| password | string | 是 | 密码 |
**响应示例**:
```json
{
"status": "success",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_in": 3600,
"user_info": {
"username": "admin",
"role": "administrator"
}
}
}
```
### 2.6 创建新闻（管理员）
```
POST /news
```
**请求参数**:
| 字段名 | 类型 | 必填 | 说明 |
|-------------|--------|------|--------------------|
| title | string | 是 | 标题 |
| content | string | 是 | 内容 |
| summary | string | 否 | 摘要 |
| category | string | 是 | 分类 |
| author | string | 否 | 作者 |
| image_url | string | 否 | 图片URL |
**响应示例**:
```json
{
"status": "success",
"data": {
"id": 101,
"title": "新发布的新闻",
"created_at": "2025-08-19T10:00:00Z",
"publish_time": "2025-08-19T10:00:00Z"
}
}
```
## 3. 版本历史
### v1.1.0 (2024-01-20)
- 新增: 按照API文档规范标准统一格式
- 优化: 统一响应格式和错误处理
- 功能: 完善官网接口定义