SuperAPI AI 工具集

fastapi-expert

编程与开发

查看项目

更新于 10-16 23:14

技能介绍

用途

fastapi-expert 是一个面向 FastAPI 生产级 API 开发的技能,聚焦异步 Python、Pydantic V2 与 FastAPI 的深度实践。它适用于以下场景:使用 FastAPI 构建 REST API、实现 Pydantic V2 校验模式、搭建异步数据库操作、实现 JWT 认证与授权、创建 WebSocket 端点,以及优化 API 性能。

主要能力

技能围绕一套核心工作流组织:

  1. 分析需求——识别端点、数据模型与认证需求;
  2. 设计模式——创建用于校验的 Pydantic V2 模型;
  3. 实现——编写带正确依赖注入的异步端点;
  4. 安全加固——加入认证、授权与限流;
  5. 测试——使用 pytest 与 httpx 编写异步测试;每组端点完成后运行 pytest,并在 /docs 验证 OpenAPI 文档。

每一步都设有检查点:确认模式校验正确、端点返回预期 HTTP 状态码、/docs 反映预期的 API 表面后再继续。

技能提供按主题拆分的参考文档,按上下文加载:

主题 参考文档 加载时机
Pydantic V2 references/pydantic-v2.md 创建模式、校验、model_config
SQLAlchemy references/async-sqlalchemy.md 异步数据库、模型、CRUD 操作
端点 references/endpoints-routing.md APIRouter、依赖、路由
认证 references/authentication.md JWT、OAuth2、get_current_user
测试 references/testing-async.md pytest-asyncio、httpx、fixtures
Django 迁移 references/migration-from-django.md 从 Django/DRF 迁移到 FastAPI

使用方式

技能以最小完整示例展示模式、端点与依赖注入的协同写法,包括:

  • 模式文件(Pydantic 模型):使用 field_validator 做密码强度校验,使用 model_config 配置 str_strip_whitespace 与 from_attributes;
  • 端点文件(带端点的路由):使用 APIRouter、Annotated 依赖注入、response_model 与规范状态码;
  • CRUD 操作:使用异步 SQLAlchemy 的 select、db.execute、db.commit、db.refresh;
  • JWT 认证片段:使用 jose 的 jwt、OAuth2PasswordBearer、create_access_token 与 get_current_user。

实现 FastAPI 功能时,技能建议输出:模式文件(Pydantic 模型)、端点文件(路由与端点)、涉及数据库时的 CRUD 操作,以及关键决策的简要说明。

约束

必须遵守:

  • 处处使用类型提示(FastAPI 要求);
  • 使用 Pydantic V2 语法(field_validator、model_validator、model_config);
  • 依赖注入使用 Annotated 模式;
  • 所有 I/O 操作使用 async/await;
  • 使用 X | None 而非 Optional[X];
  • 返回正确的 HTTP 状态码;
  • 记录端点(自动生成 OpenAPI)。

禁止:

  • 使用同步数据库操作;
  • 跳过 Pydantic 校验;
  • 以明文存储密码;
  • 在响应中暴露敏感数据;
  • 使用 Pydantic V1 语法(@validator、class Config);
  • 不当混用同步与异步代码;
  • 硬编码配置值。

适用场景与限制

该技能适合需要构建异步、类型安全、带认证与数据库操作的 FastAPI 服务的开发者,也覆盖从 Django/DRF 迁移到 FastAPI 的参考。其知识范围包括 FastAPI、Pydantic V2、异步 SQLAlchemy、Alembic 迁移、JWT/OAuth2、pytest-asyncio、httpx、BackgroundTasks、WebSockets、依赖注入与 OpenAPI/Swagger。

关于该技能的收费、价格、平台支持范围、具体效果或未在上述资料中提及的使用步骤,资料暂未提供。

引用文档

以下为作者声明的引用来源,保留指定版本、署名和许可。

作者的来源声明