docs: 重构API文档和系统架构文档,统一技术栈规范docs(architecture): 更新系统架构设计文档
- 重新组织文档结构,优化标题层级 - 添加系统架构图,直观展示系统组成- 补充前端架构、后端架构、数据架构等详细内容 - 更新安全架构、部署架构、性能优化策略等章节 - 增加扩展性设计和高可用设计章节 - 总结系统架构设计特点和优势
This commit is contained in:
@@ -12,12 +12,18 @@
|
||||
### 1.2 基础路径
|
||||
`/api/v1/farming`
|
||||
|
||||
### 1.3 权限控制
|
||||
### 1.3 技术栈
|
||||
- **后端**: Java Spring Boot + Spring Cloud (farming-service, 端口: 8081)
|
||||
- **数据库**: MySQL
|
||||
- **缓存**: Redis
|
||||
- **API文档**: Swagger
|
||||
|
||||
### 1.4 权限控制
|
||||
- 公开接口(无需认证):数据查询
|
||||
- 管理接口(需要认证):数据录入和管理
|
||||
- 系统接口(高级权限):批量操作和配置
|
||||
|
||||
### 1.4 全局错误码
|
||||
### 1.5 全局错误码
|
||||
| 状态码 | 说明 |
|
||||
|--------|--------------------|
|
||||
| 400 | 请求参数无效 |
|
||||
@@ -50,7 +56,8 @@ POST /cattles
|
||||
"id": "CATTLE001",
|
||||
"ear_tag": "NM000001",
|
||||
"created_at": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
},
|
||||
"timestamp": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -77,7 +84,8 @@ POST /cattles/batch
|
||||
"error": "耳标号格式错误"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"timestamp": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -104,7 +112,8 @@ POST /vaccinations
|
||||
"cattle_id": "CATTLE001",
|
||||
"vaccine_type": "口蹄疫",
|
||||
"created_at": "2024-01-20T10:30:00Z"
|
||||
}
|
||||
},
|
||||
"timestamp": "2024-01-20T10:30:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -121,7 +130,8 @@ POST /vaccinations
|
||||
- 新增: 按照API文档规范标准统一格式
|
||||
- 优化: 统一响应格式和错误处理
|
||||
- 功能: 完善养殖管理接口定义
|
||||
## 3. 版本历史
|
||||
- 新增: Java后端技术栈说明
|
||||
- 新增: timestamp字段
|
||||
|
||||
### v1.0.0 (2024-01-20)
|
||||
- 新增: 按照API文档规范标准统一格式
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 养殖助手小程序 API 文档
|
||||
# 养殖助手小程序 API 文档 (v1.1.0)
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
@@ -10,6 +10,12 @@
|
||||
### 1.2 基础路径
|
||||
`/api/mini/farming`
|
||||
|
||||
### 1.3 后端技术栈
|
||||
- **主要后端**: Java Spring Boot + Spring Cloud (farming-service, 端口: 8081)
|
||||
- **辅助后端**: Node.js + Express.js
|
||||
- **数据库**: MySQL
|
||||
- **缓存**: Redis
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
### 2.1 添加饲喂记录
|
||||
@@ -30,4 +36,13 @@ POST /vaccinations
|
||||
|
||||
## 3. 数据规范
|
||||
- 时间字段格式: YYYY-MM-DD HH:mm:ss
|
||||
- 数量单位统一使用kg
|
||||
- 数量单位统一使用kg
|
||||
|
||||
## 4. 版本历史
|
||||
|
||||
### v1.1.0 (2024-01-20)
|
||||
- 新增: Java后端技术栈说明
|
||||
- 优化: 接口规范说明
|
||||
|
||||
### v1.0.0 (2024-01-20)
|
||||
- 新增: 基础接口定义
|
||||
@@ -1,4 +1,4 @@
|
||||
# 用户中心系统 API 文档 (v1.0.0)
|
||||
# 用户中心系统 API 文档 (v1.1.0)
|
||||
|
||||
## 1. 接口概述
|
||||
|
||||
@@ -8,14 +8,20 @@
|
||||
- 权限控制
|
||||
|
||||
### 1.2 基础路径
|
||||
`/api/v1/[系统名称]`
|
||||
`/api/v1/users`
|
||||
|
||||
### 1.3 权限控制
|
||||
### 1.3 技术栈
|
||||
- **后端**: Java Spring Boot + Spring Cloud (user-center-service, 端口: 8082)
|
||||
- **数据库**: MySQL
|
||||
- **缓存**: Redis
|
||||
- **API文档**: Swagger
|
||||
|
||||
### 1.4 权限控制
|
||||
- 公开接口(无需认证):数据查询
|
||||
- 管理接口(需要认证):数据管理
|
||||
- 系统接口(高级权限):配置管理
|
||||
|
||||
### 1.4 全局错误码
|
||||
### 1.5 全局错误码
|
||||
| 状态码 | 说明 |
|
||||
|--------|--------------------|
|
||||
| 400 | 请求参数无效 |
|
||||
@@ -23,7 +29,6 @@
|
||||
| 403 | 权限不足 |
|
||||
| 404 | 资源不存在 |
|
||||
| 500 | 服务器内部错误 |
|
||||
`/api/v1/users`
|
||||
|
||||
## 2. 接口明细
|
||||
|
||||
@@ -48,7 +53,8 @@ POST /register
|
||||
"username": "testuser",
|
||||
"phone": "13800138000",
|
||||
"created_at": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
},
|
||||
"timestamp": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -75,7 +81,8 @@ POST /login
|
||||
"roles": ["user"]
|
||||
},
|
||||
"expires_in": 86400
|
||||
}
|
||||
},
|
||||
"timestamp": "2024-01-20T10:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -85,7 +92,15 @@ POST /login
|
||||
| 200 | 成功 |
|
||||
| 400 | 参数校验失败 |
|
||||
| 401 | 认证失败 |
|
||||
## 3. 版本历史
|
||||
|
||||
## 4. 版本历史
|
||||
|
||||
### v1.1.0 (2024-01-20)
|
||||
- 新增: 按照API文档规范标准统一格式
|
||||
- 优化: 统一响应格式和错误处理
|
||||
- 功能: 完善用户中心接口定义
|
||||
- 新增: Java后端技术栈说明
|
||||
- 新增: timestamp字段
|
||||
|
||||
### v1.0.0 (2024-01-20)
|
||||
- 新增: 按照API文档规范标准统一格式
|
||||
|
||||
Reference in New Issue
Block a user