SuperAPI AI 工具集

fastapi-expert

编程与开发

查看项目

更新于 10-16 23:14

技能介绍

用途

fastapi-expert 面向使用 FastAPI 构建生产级 API 的开发者,强调异步 Python、Pydantic V2 校验以及工程化的 API 开发方式。适用于构建 REST API、实现 Pydantic V2 校验 schema、搭建异步数据库操作、实现 JWT 认证与授权、创建 WebSocket 端点以及优化 API 性能等任务。

主要能力与工作流

技能定义了一套核心工作流:

  1. 分析需求:确定端点、数据模型与认证需求。
  2. 设计 schema:创建 Pydantic V2 模型用于校验。
  3. 实现:编写带恰当依赖注入的异步端点。
  4. 安全:加入认证、授权与限流。
  5. 测试:用 pytest 与 httpx 编写异步测试;在每组端点完成后运行 pytest,并在 /docs 检查 OpenAPI 文档。 每一步之后设置检查点:确认 schema 校验正确、端点返回预期的 HTTP 状态码、/docs 反映预期的 API 面,再继续下一步。

使用方式与示例

技能给出最小的完整示例,把 schema、端点与依赖注入放在一个连贯单元中,包括:schemas.py 中的 UserCreate 与 UserResponse(含 field_validator 密码强度校验、model_config 的 str_strip_whitespace 与 from_attributes);routers/users.py 中使用 APIRouter、Annotated[AsyncSession, Depends(get_db)] 的异步 create_user 端点,并在邮箱重复时抛出 409;crud.py 中基于 select 的 get_user_by_email 与包含提交、刷新的 create_user。 此外提供 JWT 认证片段(security.py):使用 jose 的 jwt、OAuth2PasswordBearer、create_access_token 与异步 get_current_user,并以 CurrentUser = Annotated[str, Depends(get_current_user)] 暴露当前用户依赖。

参考文档索引

技能按上下文提供详细参考:Pydantic V2(创建 schema、校验、model_config,见 references/pydantic-v2.md);SQLAlchemy(异步数据库、模型、CRUD,见 references/async-sqlalchemy.md);端点(APIRouter、依赖、路由,见 references/endpoints-routing.md);认证(JWT、OAuth2、get_current_user,见 references/authentication.md);测试(pytest-asyncio、httpx、fixtures,见 references/testing-async.md);Django 迁移(从 Django/DRF 迁移到 FastAPI,见 references/migration-from-django.md)。

约束(必须做 / 禁止做)

必须做:处处使用类型提示;使用 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 功能时,技能要求提供:schema 文件(Pydantic 模型)、端点文件(含端点的 router)、涉及数据库时的 CRUD 操作,以及关键决策的简要说明。知识范围包括 FastAPI、Pydantic V2、async SQLAlchemy、Alembic 迁移、JWT/OAuth2、pytest-asyncio、httpx、BackgroundTasks、WebSockets、依赖注入、OpenAPI/Swagger。

限制

该技能引用了上游文档(来源为 jeffallan/claude-skills,MIT 许可)及其指定修订版本;除资料所述外,未提供关于收费、价格、平台支持或其他效果的信息。

引用文档

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

作者的来源声明