fastapi-templates

概览

什么是 fastapi-templates？

fastapi-templates 提供了一套生产级项目模板和最佳实践，用于构建 FastAPI 后端应用。它专为希望快速搭建结构健全、支持异步、依赖注入和集成错误处理的 FastAPI 项目的 Python 开发者设计。该技能非常适合启动新的后端 API 项目、微服务或需要可扩展且易维护代码库的 Web 服务的团队或个人。

谁适合使用 fastapi-templates？

• 使用 Python 和 FastAPI 的后端开发者
• 启动新 REST API 或微服务的团队
• 需要异步数据库支持（PostgreSQL、MongoDB）的项目
• 寻求经过验证的 FastAPI 应用项目结构的任何人

fastapi-templates 解决了哪些问题

• 无需从零设计项目结构
• 推广异步编程和依赖注入的最佳实践
• 缩短新 FastAPI 项目的搭建时间
• 有助于确保后端服务的一致性和可维护性

使用方法

安装步骤

1. 使用以下命令将技能添加到项目中：

   npx skills add https://github.com/wshobson/agents --skill fastapi-templates
   

2. 查看主要文档文件：

   • 从 SKILL.md 开始，了解高级概览和使用说明。
   • 查阅 README.md、AGENTS.md 和 metadata.json 获取更多背景和配置细节。
   • 浏览 rules/、resources/、references/ 和 scripts/ 目录，获取支持材料和辅助脚本。

项目结构概览

推荐的布局包括：

• app/api/ 用于 API 路由和依赖
• app/core/ 用于配置、安全和数据库设置
• app/models/ 用于数据库模型
• app/schemas/ 用于 Pydantic 模式
• app/services/ 用于业务逻辑
• app/repositories/ 用于数据访问
• app/main.py 作为应用入口点

该结构支持可扩展开发和清晰的职责分离。

将 fastapi-templates 适配到你的工作流程

• 使用提供的模板作为起点，然后根据具体需求进行定制。
• 根据需要集成你偏好的数据库（PostgreSQL、MongoDB）和认证方式。
• 利用 FastAPI 的依赖注入系统，实现模块化和可测试代码。

常见问题

什么时候应该使用 fastapi-templates？

当你启动新的 FastAPI 后端项目，尤其需要异步支持、清晰的项目结构和内置最佳实践时，使用 fastapi-templates 非常合适。它适用于 REST API 和微服务。

支持哪些数据库？

模板设计时主要支持异步数据库，如 PostgreSQL 和 MongoDB，但也可以适配其他后端。

可以在现有项目中使用 fastapi-templates 吗？

虽然主要面向新项目，但你也可以在现有 FastAPI 代码库中采用部分结构和最佳实践。

哪里可以找到更多细节？

打开技能目录中的 Files 标签，浏览完整文件树，包括嵌套引用和辅助脚本。建议从 SKILL.md 开始，获得引导式概览。