SuperAPI AI 工具集

fastapi-best-practices

编程与开发

查看项目

更新于 10-16 01:36

技能介绍

用途:为 FastAPI 应用提供生产级最佳实践与规则集,覆盖 7 个以上类别,可用于指导自动化重构和代码生成。

主要能力:按优先级组织规则,包括异步与并发(async-,CRITICAL)、项目结构(structure-,HIGH)、Pydantic 模式(pydantic-,HIGH)、依赖注入(dependency-,MEDIUM-HIGH)、数据库与存储(db-,MEDIUM)、REST 与 API 设计(api-,MEDIUM)、测试与工具(tooling-,LOW-MEDIUM),另含代码维护、性能优化与 TDD 策略。

关键规则示例:async-io-intensive 建议对可等待对象用 async def、对阻塞 I/O 用 def;async-cpu-intensive 建议将 CPU 工作交给 multiprocessing/Celery;async-sync-sdk 建议在异步路由中用 run_in_threadpool 包装同步 SDK;structure-domain-driven 建议按领域组织 src/{domain};pydantic 相关规则涉及内置校验、自定义基类、按领域拆分 BaseSettings、用 ValueError 报校验错误;dependency 相关规则涉及用 Depends 做数据库校验、链式依赖、解耦与异步依赖;db 相关规则涉及命名约定、索引命名、SQL 优先与可逆迁移;api 相关规则涉及路径命名、响应序列化、生产环境隐藏文档与 OpenAPI 元数据;tooling 建议用 AsyncClient/httpx 测试、用 Ruff 做 lint。

使用方式:按需阅读 rules/ 下的单个规则文件(如 rules/async-io-intensive.md、rules/structure-domain-driven.md);完整编译文档见 AGENTS.md;scripts/ 提供辅助脚本(如 run_ruff.py);references/ 提供补充指南(如 quad_strategy.md);TDD 策略见 rules/tdd-strategy.md。

适用场景:新建 FastAPI 项目结构、实现异步路由与阻塞 I/O 处理、设计 Pydantic 模型与校验、组织依赖注入、集成 SQLAlchemy 与 Alembic、编写测试与配置 CI/CD。

限制:资料未提供具体版本要求、安装命令、许可与收费信息,暂未提供。