メニュー
Conventions for writing FastAPI endpoints with proper typing, status codes, and error handling Use when this capability is needed.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
SOC 職業分類に基づく
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/tomevault-io/skills-registry --skill fastapi-endpoint-patternsコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
SKILL.md を表示中
| Use when this capability is needed.
> Use when this capability is needed.
Review architecture and API design for the vfs-s3 project. Use when the user mentions @architect, asks to review an issue's design, discuss module boundaries, API shape, or architectural decisions for vfs-s3. Also trigger when the user wants to create an ADR (Architecture Decision Record) or evaluate a technical approach for the project. Intended for dispatch from Codex automation or Claude routines; GitHub trigger phrase: @vfs-s3-bot please prepare design doc Use when this capability is needed.
| name | fastapi-endpoint-patterns |
| description | Conventions for writing FastAPI endpoints with proper typing, status codes, and error handling Use when this capability is needed. |
| metadata | {"author":"ag2ai"} |
Always use async def. Specify response_model and status_code.
from fastapi import APIRouter, Depends, HTTPException, status
from sqlalchemy.ext.asyncio import AsyncSession
from app.deps.database import get_db
from app.schemas.user import UserCreate, UserRead
from app.services import user_service
router = APIRouter()
@router.post("/", response_model=UserRead, status_code=status.HTTP_201_CREATED)
async def create_user(
payload: UserCreate,
db: AsyncSession = Depends(get_db),
) -> UserRead:
user = await user_service.create_user(db, payload)
return user
Define separate schemas for create, read, and update operations:
from pydantic import BaseModel, ConfigDict
class UserBase(BaseModel):
email: str
name: str
class UserCreate(UserBase):
password: str
class UserUpdate(BaseModel):
email: str | None = None
name: str | None = None
class UserRead(UserBase):
id: int
model_config = ConfigDict(from_attributes=True)
UserCreate -- what the client sends to create a resource.UserUpdate -- partial update; all fields optional.UserRead -- what the API returns. Includes id, excludes password.Use explicit status codes from fastapi.status:
| Operation | Status Code | Constant |
|---|---|---|
| Create | 201 | HTTP_201_CREATED |
| Read | 200 | HTTP_200_OK (default) |
| Update | 200 | HTTP_200_OK |
| Delete | 204 | HTTP_204_NO_CONTENT |
For 204 responses, set response_model=None:
@router.delete("/{user_id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None)
async def delete_user(user_id: int, db: AsyncSession = Depends(get_db)):
await user_service.delete_user(db, user_id)
Inject shared resources with Depends():
from fastapi import Depends
from app.deps.auth import get_current_user
from app.deps.database import get_db
@router.get("/me", response_model=UserRead)
async def get_me(
current_user: UserRead = Depends(get_current_user),
) -> UserRead:
return current_user
Chain dependencies for layered auth:
# app/deps/auth.py
async def get_current_user(token: str = Depends(oauth2_scheme), db=Depends(get_db)):
user = await verify_token(token, db)
if not user:
raise HTTPException(status_code=401, detail="Invalid token")
return user
async def require_admin(user=Depends(get_current_user)):
if not user.is_admin:
raise HTTPException(status_code=403, detail="Admin required")
return user
Raise HTTPException for expected errors:
@router.get("/{user_id}", response_model=UserRead)
async def get_user(user_id: int, db: AsyncSession = Depends(get_db)) -> UserRead:
user = await user_service.get_user_by_id(db, user_id)
if not user:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"User {user_id} not found",
)
return user
Use exception handlers for global error formatting:
# app/main.py
from fastapi.responses import JSONResponse
@app.exception_handler(ValueError)
async def value_error_handler(request, exc):
return JSONResponse(status_code=400, content={"detail": str(exc)})
@router.get("/", response_model=list[UserRead])
async def list_users(
skip: int = 0,
limit: int = 100,
search: str | None = None,
db: AsyncSession = Depends(get_db),
) -> list[UserRead]:
return await user_service.list_users(db, skip=skip, limit=limit, search=search)
Use Path() and Query() for validation:
from fastapi import Path, Query
@router.get("/{user_id}")
async def get_user(
user_id: int = Path(..., gt=0, description="The user ID"),
fields: list[str] = Query(default=[], description="Fields to include"),
):
...
Source: ag2ai/resource-hub — distributed by TomeVault.