AgentSkillsCN

fastapi-router-py

使用 FastAPI 创建包含 CRUD 操作、认证依赖以及恰当响应模型的路由器。适用于构建 REST API 端点、创建新路由、实现 CRUD 操作，或在 FastAPI 应用程序中添加经过身份验证的端点。

SKILL.md
--- frontmatter
name: fastapi-router-py
description: Create FastAPI routers with CRUD operations, authentication dependencies, and proper response models. Use when building REST API endpoints, creating new routes, implementing CRUD operations, or adding authenticated endpoints in FastAPI applications.

FastAPI Router

Create FastAPI routers following established patterns with proper authentication, response models, and HTTP status codes.

Quick Start

Copy the template from assets/template.py and replace placeholders:

  • •{{ResourceName}} → PascalCase name (e.g., Project)
  • •{{resource_name}} → snake_case name (e.g., project)
  • •{{resource_plural}} → plural form (e.g., projects)

Authentication Patterns

python
# Optional auth - returns None if not authenticated
current_user: Optional[User] = Depends(get_current_user)

# Required auth - raises 401 if not authenticated
current_user: User = Depends(get_current_user_required)

Response Models

python
@router.get("/items/{item_id}", response_model=Item)
async def get_item(item_id: str) -> Item:
    ...

@router.get("/items", response_model=list[Item])
async def list_items() -> list[Item]:
    ...

HTTP Status Codes

python
@router.post("/items", status_code=status.HTTP_201_CREATED)
@router.delete("/items/{id}", status_code=status.HTTP_204_NO_CONTENT)

Integration Steps

  1. •Create router in src/backend/app/routers/
  2. •Mount in src/backend/app/main.py
  3. •Create corresponding Pydantic models
  4. •Create service layer if needed
  5. •Add frontend API functions