docs:更新项目文档结构和说明

- 重新组织docs目录结构
- 在README中添加API文档系统介绍
- 提供Swagger UI快速访问指南
- 完善文档导航和使用说明
This commit is contained in:
moyin
2025-12-17 15:16:54 +08:00
parent 1e47c4db60
commit 08bf2bbaf3
2 changed files with 178 additions and 2 deletions

View File

@@ -173,10 +173,18 @@ export class PlayerService {
- [命名规范](./docs/naming_convention.md) - 项目命名规范和最佳实践
- [NestJS 使用指南](./docs/nestjs_guide.md) - 详细的 NestJS 开发指南,包含实战案例
### 📖 API 文档
- **[API 文档总览](./docs/api/README.md)** - API 文档使用指南和快速开始
- **[Swagger UI](http://localhost:3000/api-docs)** - 交互式 API 文档(需启动服务器)
- [详细接口文档](./docs/api/api-documentation.md) - 完整的 API 接口说明
- [OpenAPI 规范](./docs/api/openapi.yaml) - 标准化的 API 描述文件
- [Postman 集合](./docs/api/postman-collection.json) - 可导入的 API 测试集合
### 💡 使用建议
1. **开发前**:先读 AI 辅助指南,了解如何用 AI 帮助遵循规范
2. **开发中**:参考具体规范文档,使用 AI 实时检查代码质量
3. **提交前**:用 AI 检查代码和提交信息是否符合规范
3. **API 开发**使Swagger UI 进行接口测试,参考 API 文档进行开发
4. **提交前**:用 AI 检查代码和提交信息是否符合规范
## 前置要求
@@ -262,10 +270,19 @@ test/
├── api/ # API 测试
└── service/ # 服务测试
docs/ # 项目文档
├── api/ # API 接口文档
│ ├── README.md # API 文档使用指南
│ ├── api-documentation.md # 详细接口文档
│ ├── openapi.yaml # OpenAPI 规范文件
│ └── postman-collection.json # Postman 测试集合
├── systems/ # 系统设计文档
│ ├── logger/ # 日志系统文档
│ └── user-auth/ # 用户认证系统文档
├── backend_development_guide.md # 后端开发规范
├── git_commit_guide.md # Git 提交规范
├── naming_convention.md # 命名规范
── nestjs_guide.md # NestJS 使用指南
── nestjs_guide.md # NestJS 使用指南
└── AI辅助开发规范指南.md # AI 辅助开发指南
```
## 核心功能
@@ -282,6 +299,26 @@ docs/ # 项目文档
**详细文档**: [用户认证系统文档](./docs/systems/user-auth/README.md)
### 📖 API 文档系统
集成了完整的 API 文档解决方案,提供多种格式的接口文档:
- **Swagger UI** - 交互式 API 文档界面
- **OpenAPI 规范** - 标准化的 API 描述文件
- **Postman 集合** - 可导入的 API 测试集合
- **详细文档** - 包含示例和最佳实践的完整说明
**快速访问**:
```bash
# 启动服务器
pnpm run dev
# 访问 Swagger UI 文档
# 浏览器打开: http://localhost:3000/api-docs
```
**详细文档**: [API 文档说明](./docs/api/README.md)
### 📊 日志系统
基于 Pino 的高性能日志系统,提供结构化日志记录: