Repolode
提交项目
zhanymkanov

zhanymkanov/fastapi-best-practices

源自创业团队实践的 FastAPI 生产项目最佳实践与编码约定。

在 GitHub 查看
Star
18,217
Fork
1,329
未关闭 Issue
16
最近提交
2个月前

这是什么？

这是一份面向生产环境的 FastAPI 后端编码约定指南，内容基于作者团队多年的实践经验。涵盖以领域划分的单体项目结构、同步与异步路由和依赖的选择，以及 Pydantic 模型与配置的组织方式，并说明如何用依赖做数据校验和复用。

指南还包括数据与工具相关主题：SQL 优先的查询设计、Alembic 迁移规范、数据库命名约定、BackgroundTasks 与真正任务队列的取舍、API 文档的显示控制，以及使用 httpx 和依赖覆盖编写异步集成测试。大部分章节都附有示例代码。

适合已经熟悉 FastAPI、希望规范项目结构并避免常见陷阱（如阻塞事件循环、误用 BackgroundTasks）的 Python 开发者阅读。仓库还提供 AGENTS.md，以便 AI 编程助手使用同样的规则。

核心功能

  • 01按领域模块组织单体项目的目录结构建议。
  • 02说明同步与异步路由、依赖在线程池中的运行方式。
  • 03用依赖链和请求级缓存实现数据校验与复用的模式。
  • 04Pydantic 约定，包括自定义基类和拆分的 BaseSettings 配置。
  • 05SQL 优先的查询思路、Alembic 迁移规范与数据库命名规则。
  • 06基于异步 httpx 客户端与 dependency_overrides 的测试方案，并使用 ruff 进行检查与格式化。

适用场景

  • 为功能不断增长、模块众多的 FastAPI 单体项目规划结构。
  • 让新成员快速了解团队的 FastAPI 编码规范。
  • 检查异步与同步代码的选择，避免阻塞事件循环。
  • 通过 AGENTS.md 让 AI 编程助手遵循一致的 FastAPI 规则。

使用前须知

  • 项目元数据中未注明许可证。

标签

#fastapi#python#best-practices#pydantic#sqlalchemy#async#backend-architecture

常见问题

fastapi-best-practices 是什么？
源自创业团队实践的 FastAPI 生产项目最佳实践与编码约定。 这是一份面向生产环境的 FastAPI 后端编码约定指南，内容基于作者团队多年的实践经验。涵盖以领域划分的单体项目结构、同步与异步路由和依赖的选择，以及 Pydantic 模型与配置的组织方式，并说明如何用依赖做数据校验和复用。
fastapi-best-practices 可以免费使用吗？用的什么许可证？
fastapi-best-practices 没有声明许可证。代码虽然公开，但没有许可证就没有明确的使用授权，正式使用前建议先联系作者。
fastapi-best-practices 还在维护吗？
半年内有更新。fastapi-best-practices 最近一次提交是在 2026年8月27日。
fastapi-best-practices 适合用来做什么？
为功能不断增长、模块众多的 FastAPI 单体项目规划结构。 让新成员快速了解团队的 FastAPI 编码规范。 检查异步与同步代码的选择，避免阻塞事件循环。 通过 AGENTS.md 让 AI 编程助手遵循一致的 FastAPI 规则。
在哪里获取 fastapi-best-practices？
源代码和安装说明在 GitHub 上：https://github.com/zhanymkanov/fastapi-best-practices

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目