Files
FastapiAdmin/fastdocs
zhangtao 01fd6c8ea4 docs(backend): 重构后端README文档,完善项目文档与开发指南
- 全面更新README,添加项目特性、架构设计与技术栈介绍
- 详细补充项目结构说明及模块设计规范
- 增加快速开始步骤,包括环境配置、数据库初始化和服务启动
- 补充主要API模块路径和认证授权使用示例
- 添加开发指南、数据库迁移与测试方法
- 集成监控、日志级别说明及性能监控内容
- 完善Docker、传统部署及Nginx配置示例
- 添加贡献指南和代码规范说明
- 新增MCP模块概述及智能对话API接口文档
- 清理和移除module_ai中旧的mcp_server相关实现代码
- 在api/v1初始化文件中注册AI模块路由
- 修改resource模块,增强资源路径安全检查和文件类型检测逻辑
- 增强资源搜索和上传服务的健壮性及安全性
2025-09-08 00:45:34 +08:00
..

fastdocs

项目结构

fastapi_vue3_admin/fastdocs
├─ .vitepress           # 静态资源文件
│  ├─ cache             # 缓存
│  ├─ theme             # 主题
│  └─ config.js         # 配置文件
├─ src                  # 源代码
│  ├─ about             # 关于
│  ├─ guide.md          # 指南
│  └─ index.md          # 首页
├─ package.json         # 项目依赖文件件
└─ README.md            # 项目说明文档

快速开始

# 进入前端工程目录
cd fastdocs
# 安装依赖
pnpm install
# 运行文档工程
pnpm run docs:dev
# 构建文档工程
pnpm run docs:build