Files
FastapiAdmin/backend/app/plugin/init_app.py
T
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

156 lines
5.6 KiB
Python

# -*- coding: utf-8 -*-
from typing import Any, AsyncGenerator
from fastapi_mcp import FastApiMCP
from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles
from fastapi.concurrency import asynccontextmanager
from fastapi.openapi.docs import (
get_redoc_html,
get_swagger_ui_html,
get_swagger_ui_oauth2_redirect_html
)
from app.config.setting import settings
from app.core.ap_scheduler import SchedulerUtil
from app.core.logger import logger
from app.utils.common_util import import_module, import_modules_async
from app.core.exceptions import (
CustomException,
CustomExceptionHandler,
HTTPException,
HttpExceptionHandler,
ValidationExceptionHandler,
RequestValidationError,
SQLAlchemyError,
SQLAlchemyExceptionHandler,
ValueExceptionHandler,
FieldValidationError,
FieldValidationExceptionHandler,
AllExceptionHandler,
ResponseValidationHandle,
ResponseValidationError
)
from app.core.database import session_connect, test_db_connection
from app.scripts.initialize import InitializeData
from app.api.v1.module_system.config.service import ConfigService
from app.api.v1.module_system.dict.service import DictDataService
from app.api.v1 import router
@asynccontextmanager
async def lifespan(app: FastAPI) -> AsyncGenerator[Any, Any]:
"""
自定义生命周期
"""
logger.info(settings.BANNER + '\n' + f'{settings.TITLE} 服务开始启动...')
try:
async with session_connect() as session:
async with session.begin():
# 测试数据库连接
await test_db_connection(session)
logger.info("数据库连接成功...")
await InitializeData().init_db(db=session)
logger.info("初始化数据完成...")
# 在同一个事务中完成所有初始化操作
await import_modules_async(modules=settings.EVENT_LIST, desc="全局事件", app=app, status=True)
await ConfigService().init_config_service(redis=app.state.redis, db=session)
logger.info("初始化系统配置完成...")
await DictDataService().init_dict_service(redis=app.state.redis, db=session)
logger.info('初始化数据字典完成...')
await SchedulerUtil.init_system_scheduler(db=session)
logger.info('初始化定时任务完成...')
logger.info(f'{settings.TITLE} 服务成功启动...')
except Exception as e:
logger.error(f'{settings.TITLE} 服务启动失败: {str(e)}')
raise e
yield
await import_modules_async(modules=settings.EVENT_LIST, desc="全局事件", app=app, status=False)
await SchedulerUtil.close_system_scheduler()
logger.info(f'{settings.TITLE} 服务关闭...')
def register_middlewares(app: FastAPI) -> None:
"""
注册中间件
"""
for middleware in settings.MIDDLEWARE_LIST[::-1]:
if not middleware:
continue
middleware = import_module(middleware, desc="中间件")
app.add_middleware(middleware)
def register_exceptions(app: FastAPI) -> None:
"""
异常捕捉
"""
app.add_exception_handler(CustomException, CustomExceptionHandler)
app.add_exception_handler(HTTPException, HttpExceptionHandler)
app.add_exception_handler(RequestValidationError,ValidationExceptionHandler)
app.add_exception_handler(SQLAlchemyError, SQLAlchemyExceptionHandler)
app.add_exception_handler(ValueError, ValueExceptionHandler)
app.add_exception_handler(Exception, AllExceptionHandler)
app.add_exception_handler(FieldValidationError,FieldValidationExceptionHandler)
app.add_exception_handler(ResponseValidationError,ResponseValidationHandle)
def register_routers(app: FastAPI) -> None:
"""
注册根路由
"""
app.include_router(router=router)
def register_fastapi_mcp(app: FastAPI) -> None:
"""
注册FastAPI-MCP路由
"""
mcp = FastApiMCP(
app,
name="FastAPI Vue3 Admin MCP",
description="MCP server for the FastAPI Vue3 Admin system",
describe_full_response_schema=True,
describe_all_responses=True,
)
mcp.mount()
# mcp.mount_http()
def register_files(app: FastAPI) -> None:
"""
注册文件相关配置
"""
# 挂载静态文件目录
if settings.STATIC_ENABLE:
# 确保日志目录存在
settings.STATIC_ROOT.mkdir(parents=True, exist_ok=True)
app.mount(path=settings.STATIC_URL, app=StaticFiles(directory=settings.STATIC_ROOT), name=settings.STATIC_DIR)
def reset_api_docs(app: FastAPI) -> None:
"""
自定义配置接口本地静态文档
"""
@app.get(settings.DOCS_URL, include_in_schema=False)
async def custom_swagger_ui_html():
return get_swagger_ui_html(
openapi_url=app.root_path + app.openapi_url,
title=app.title + " - Swagger UI",
oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
swagger_js_url=settings.SWAGGER_JS_URL,
swagger_css_url=settings.SWAGGER_CSS_URL,
swagger_favicon_url=settings.FAVICON_URL,
)
@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
async def swagger_ui_redirect():
return get_swagger_ui_oauth2_redirect_html()
@app.get(settings.REDOC_URL, include_in_schema=False)
async def custom_redoc_html():
return get_redoc_html(
openapi_url=app.root_path + app.openapi_url,
title=app.title + " - ReDoc",
redoc_js_url=settings.REDOC_JS_URL,
redoc_favicon_url=settings.FAVICON_URL,
)