返回顶部
f

fastapi-code-reviewFastAPI代码审查

Reviews FastAPI code for routing patterns, dependency injection, validation, and async handlers. Use when reviewing FastAPI apps, checking APIRouter setup, Depends() usage, or response models.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.1.0
安全检测
已通过
156
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

fastapi-code-review

FastAPI 代码审查

快速参考

问题类型参考文档
APIRouter 设置、responsemodel、状态码references/routes.md
Depends()、yield 依赖、清理、共享依赖
references/dependencies.md | | Pydantic 模型、HTTPException、422 处理 | references/validation.md | | 异步处理器、阻塞 I/O、后台任务 | references/async.md |

审查清单

  • - [ ] APIRouter 使用正确的前缀和标签
  • [ ] 所有路由指定了 response_model 以确保类型安全
  • [ ] 正确的 HTTP 方法(GET、POST、PUT、DELETE、PATCH)
  • [ ] 正确的状态码(200、201、204、404 等)
  • [ ] 依赖使用 Depends() 而非手动调用
  • [ ] yield 依赖有正确的清理逻辑
  • [ ] 请求/响应模型使用 Pydantic
  • [ ] HTTPException 包含状态码和详细信息
  • [ ] 所有路由处理器为 async def
  • [ ] 无阻塞 I/O(requests、time.sleep、open())
  • [ ] 非阻塞操作使用后台任务
  • [ ] 路由处理器中无裸 except

有效模式(请勿标记)

以下为符合 FastAPI 习惯用法的模式,可能看似有问题但实际正确:

  • - Pydantic 自动验证请求体 - 使用类型化的 Pydantic 模型作为参数时无需手动验证
  • 数据库会话的依赖注入 - 会话来自 Depends(),而非作为函数参数传递
  • 所有 HTTP 错误使用 HTTPException - FastAPI 处理转换为正确的 HTTP 响应
  • 无 await 的 async def 端点 - 可能使用同步依赖或简单操作;FastAPI 可处理
  • Depends() 上的类型注解 - 这是文档/IDE 支持,而非类型断言
  • Query/Path/Body 默认值 - FastAPI 在运行时处理,非传统 Python 默认值
  • 从端点返回字典 - 如果设置了 response_model,Pydantic 会自动转换

上下文敏感规则

仅在上下文需要时标记问题:

  • - 标记缺少验证 仅当字段不在包含验证器的 Pydantic 模型中时
  • 标记缺少认证 仅当端点未使用包含认证依赖的 Depends() 时
  • 标记缺少错误处理 仅当错误情况未适当引发 HTTPException 时
  • 标记异步中的同步 仅当操作确实阻塞(文件 I/O、网络调用、CPU 密集型),而非仅非异步

FastAPI 框架行为

FastAPI + Pydantic 自动处理许多关注点:

  • - 通过 Pydantic 模型进行请求验证
  • 通过 response_model 进行响应序列化
  • 横切关注点的依赖注入
  • 通过异常处理器进行异常处理

在标记缺少功能前,请确认 FastAPI 未处理该功能。

何时加载参考文档

  • - 审查路由定义 → routes.md
  • 审查依赖注入 → dependencies.md
  • 审查 Pydantic 模型/验证 → validation.md
  • 审查异步路由处理器 → async.md

审查问题

  1. 1. 所有路由是否都有明确的响应模型和状态码?
  2. 依赖是否通过 Depends() 注入并正确清理?
  3. 所有 Pydantic 模型是否正确验证输入?
  4. 所有路由处理器是否为异步且非阻塞?

提交发现前

在报告任何问题前,请加载并遵循 review-verification-protocol

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 fastapi-code-review-1776088210 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 fastapi-code-review-1776088210 技能

通过命令行安装

skillhub install fastapi-code-review-1776088210

下载

⬇ 下载 fastapi-code-review v1.1.0(免费)

文件大小: 9.51 KB | 发布时间: 2026-4-14 14:11

v1.1.0 最新 2026-4-14 14:11
- Added SKILL.md with comprehensive review guidelines and checklist for FastAPI code.
- Includes detailed reference mapping for routes, dependencies, validation, and async patterns.
- Clarifies valid FastAPI idioms that should NOT be flagged during review.
- Provides context-sensitive rules to improve accuracy and relevance of flagged issues.
- Introduces a review protocol to follow before submitting findings.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部