安装方式
手动下载安装
下载 ZIP 后解压到技能目录即可安装。若在桌面客户端 WebView中直接下载出现异常,本站会改为提示页 + 原始链接,请按页内说明操作。
下载 ZIP (shub-fastapi-patterns-v1.0.0.zip)触发指令
/fastapi-patterns
跨平台安装指引
该技能声明兼容以下 1 个平台,将 ZIP 解压到对应目录即可被识别。
unzip shub-fastapi-patterns-v1.0.0.zip -d ~/.claude/skills/
mkdir -p 创建;启用 Skill 后请重启对应 Agent 让配置生效。
使用指南
FastAPI 模式
围绕 FastAPI 模式:路由分层、依赖注入、异步与 OpenAPI 文档的最佳实践;示例项目结构见 SKILL.md。 无需在每次任务前把零散英文说明手工拼进上下文,也 减少 与客户端默认行为脱节的试错;具体命令、钩子与 JSON 参数仍以 ZIP 包内 SKILL.md 为权威。下文结构与站内 MCP CLI 类专题稿相同:何时用、前置、流程、速查与故障。
何时使用
- 路由分层、依赖注入、异步与 OpenAPI 文档的最佳实践
- 示例项目结构见 SKILL.md
- 已获取本技能 ZIP,并准备在 Claude Code / OpenClaw 中按 SKILL.md 挂载。
- 希望用中文专题稿快速判断「该不该启用」,再深入英文 SKILL 查参数与边界。
- 需要与团队对齐同一套触发方式、目录约定或回调格式时。
前置条件
- 通用:可运行 Claude Code 或文档要求的客户端;有可读写的项目工作区(或 SKILL.md 指定的沙箱目录)。
- 权威细节:API Key / OAuth、钩子路径、环境变量以 ZIP 内 SKILL.md 为准。
典型流程
- 从 ClawHub / 站内分发获取技能 ZIP,校验版本与校验和(若提供)。
- 阅读 SKILL.md 的安装段落:目录落点、客户端类型(Claude Code / OpenClaw / 脚本)。
- 用文档中的最小示例完成第一次调用(单文件修改、单次查询或单次委派)。
- 确认工作目录、权限边界与输出路径后,再处理多文件或长耗时任务。
- 需要回调 / Webhook / 通知时,按 SKILL.md 配置端点并在测试环境先验通。
与 ZIP / SKILL.md 的关系
站内专题稿与 MCP CLI 类 oss 稿同样:概括何时用、怎么接、怎么排错;命令模板、钩子名、JSON 字段、版本矩阵一律以 ZIP 内 SKILL.md 与 ClawHub 上游为准。
命令示例(摘自包内 SKILL.md)
以下为从上游 SKILL.md(或入库正文)自动抽取的终端/脚本片段;路径、环境变量与参数以当前 ZIP 与官方说明为准。
ClawHub slug:fastapi-patterns(安装命令以 SKILL.md / claw CLI 为准)。
站内入库时的触发命令(完整语义见 ZIP):
# 使用本技能时可在对话中引用或执行上述指令;完整参数与示例见下载包内 SKILL.md。
/fastapi-patterns
最佳实践
- 先 SKILL.md 再猜参数;站内专题稿不替代 schema 与必填字段说明。
- 委派任务时写清验收标准(命令、文件路径、测试命令),减少来回追问。
- 长任务用文档推荐的回调 / 日志落盘代替高频轮询,省 Token 也省机器负载。
- 多技能同时启用时,注意钩子加载顺序与重复工具调用(以 SKILL.md 冲突说明为准)。
调试与排错
- 打开 stderr 与客户端日志;PTY/tmux 场景同时看面板最后几十行输出。
- 参数错误时对照 SKILL.md 中的 JSON/CLI 示例(引号、转义、工作目录)。
- 网络类失败:查代理、防火墙、MCP 传输方式(stdio / HTTP / SSE)。
速查
| 动作 | 说明 |
|------|------|
| 获取技能包 | ClawHub / 站内 ZIP,核对版本 |
| 权威步骤 | 优先阅读 ZIP 内 SKILL.md |
| 首次试跑 | 使用 SKILL.md 最小示例 |
| 验收 | 对照路径、测试命令或回调负载 |
常见故障
- 无输出或立即退出 → 工作目录错误、依赖未装、或 Claude Code 未登录;按 SKILL.md 自检清单执行。
- 权限被拒绝 → 检查沙箱路径、
--permission-mode与工具白名单。 - 与简介不符 → 以英文 SKILL 与上游仓库为准,站内稿仅作结构化导读。
# FastAPI Production Patterns
## Description
Modern FastAPI development patterns for 2026, covering the full spectrum from Pydantic v2 migration to production deployment. Validated against 15+ production sources with 0.95 confidence. This skill keeps you on the current side of breaking changes and equips you with battle-tested patterns for async, security, testing, and performance.
## Usage
Install this skill to get production-ready FastAPI patterns including:
- Pydantic v2 migration guide (breaking changes, 4-17x performance gains)
- Async vs sync endpoint decision rules
- OAuth2 + JWT authentication patterns
- Dependency override testing strategies
- Docker + Kubernetes deployment with health probes
When working on FastAPI projects, this skill provides context for:
- Migrating from Pydantic v1 to v2 without breaking existing code
- Setting up proper lifespan events instead of deprecated `@app.on_event()`
- Structuring tests with `TestClient` (sync) and `AsyncClient` (async)
- Configuring Gunicorn + Uvicorn workers for production
## Key Patterns
### Pydantic v2 Migration
```python
# BEFORE (Pydantic v1 — deprecated)
from pydantic import BaseModel, validator
class User(BaseModel):
name: str
@validator('name')
def name_must_not_be_empty(cls, v):
if not v:
raise ValueError('name cannot be empty')
return v
# AFTER (Pydantic v2 — current)
from pydantic import BaseModel, field_validator
class User(BaseModel):
name: str
@field_validator('name')
@classmethod
def name_must_not_be_empty(cls, v):
if not v:
raise ValueError('name cannot be empty')
return v
```
Method renames (v1 to v2): `parse_obj()` -> `model_validate()`, `dict()` -> `model_dump()`, `json()` -> `model_dump_json()`, `orm_mode = True` -> `model_config = ConfigDict(from_attributes=True)`, `conint(ge=0)` -> `Annotated[int, Field(ge=0)]`
### Lifespan Events (Modern Pattern)
```python
from contextlib import asynccontextmanager
from fastapi import FastAPI
ml_models = {}
@asynccontextmanager
async def lifespan(app: FastAPI):
# Startup: load resources
ml_models["answer"] = load_ml_model()
yield
# Shutdown: release resources
ml_models.clear()
app = FastAPI(lifespan=lifespan)
```
Do NOT use deprecated `@app.on_event()`. Use lifespan for: DB connection pools, ML models, resource cleanup.
### Async Decision Rule
```python
# Use async def for: asyncpg, motor, httpx (non-blocking I/O)
@app.get('/users/')
async def get_users():
users = await async_db.fetch('SELECT * FROM users')
return users
# Use def for: psycopg2, pymongo, requests (blocking libs)
# FastAPI automatically runs def endpoints in a threadpool
@app.get('/users/sync')
def get_users_sync():
return sync_db.query('SELECT * FROM users')
```
Rule of thumb: If unsure, use `def`. FastAPI handles the threadpool for you.
### OAuth2 + JWT Authentication
```python
from fastapi import Depends, HTTPException
from fastapi.security import OAuth2PasswordBearer
from jose import jwt
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
SECRET_KEY = "your-secret-key"
ALGORITHM = "HS256"
async def get_current_user(token: str = Depends(oauth2_scheme)):
try:
payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
username = payload.get("sub")
if not username:
raise HTTPException(status_code=401)
return username
except:
raise HTTPException(status_code=401)
```
### CORS (Never Use wildcard in Production)
```python
from fastapi.middleware.cors import CORSMiddleware
app.add_middleware(
CORSMiddleware,
allow_origins=["https://example.com"], # NOT ["*"]
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
```
### Async Testing with httpx
```python
import pytest
from httpx import ASGITransport, AsyncClient
@pytest.mark.anyio
async def test_async_endpoint():
async with AsyncClient(
transport=ASGITransport(app=app),
base_url="http://test"
) as ac:
response = await ac.get("/")
assert response.status_code == 200
```
### Dependency Overrides for Mocking
```python
async def override_get_db():
db = Database("sqlite:///:memory:")
yield db
await db.disconnect()
def test_with_mock_db():
app.dependency_overrides[get_db] = override_get_db
client = TestClient(app)
response = client.get("/users/")
assert response.status_code == 200
app.dependency_overrides = {} # Always clean up
```
### Production Dockerfile
```dockerfile
FROM python:3.11-slim
WORKDIR /code
COPY ./requirements.txt /code/requirements.txt
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
COPY ./app /code/app
CMD ["gunicorn", "app.main:app", "--workers", "4",
"--worker-class", "uvicorn.workers.UvicornWorker", "--bind", "0.0.0.0:80"]
```
Workers: 1 per CPU core on a single server. For Kubernetes: 1 worker per container, scale at cluster level.
### Health Check Endpoints
```python
@app.get("/health")
async def health_check():
"""Liveness: is the process running?"""
return {"status": "healthy"}
@app.get("/ready")
async def readiness_check():
"""Readiness: can it handle traffic?"""
try:
await database.execute("SELECT 1")
return {"status": "ready", "database": "ok"}
except Exception as e:
raise HTTPException(status_code=503, detail=str(e))
```
### Performance Quick Wins
```python
# Connection pooling: 2-3x throughput improvement
database = Database("postgresql://user:pass@localhost/db", min_size=5, max_size=20)
# Response caching: 90%+ database load reduction
@cache(expire=60)
async def get_user(user_id: int):
return await db.fetch_one(...)
# Async middleware: 10-30% latency reduction
@app.middleware("http")
async def async_middleware(request, call_next):
return await call_next(request) # NOT blocking def
```
### Common Pitfall: Blocking Inside Async
```python
# WRONG: blocks the event loop
@app.get("/data")
async def get_data():
response = requests.get("https://api.com") # Blocks!
# CORRECT: use async library
import httpx
@app.get("/data")
async def get_data():
async with httpx.AsyncClient() as client:
response = await client.get("https://api.com")
```
## Tools & References
- [FastAPI Official Docs](https://fastapi.tiangolo.com/)
- [Pydantic v2 Migration Guide](https://docs.pydantic.dev/latest/migration/)
- `pip install fastapi[all]` - FastAPI with all optional dependencies
- `pip install pytest anyio httpx` - async testing stack
---
*Published by [MidOS](https://midos.dev) — MCP Community Library*