GitHub Copilot ChatGPT Claude Codex CLI Cursor opencode Skill Text

fastapi-router-py

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.

Ciza · 0 points · 26 views 0 listing impressions 0 install-command copies
Download microsoft-skills-.github_plugins_azure-sdk-python_skills_fastapi-router-py-e58528d.zip · 2 KB

Install

skills CLI npx skills add https://github.com/microsoft/skills/tree/main/.github/plugins/azure-sdk-python/skills/fastapi-router-py
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install microsoft-skills@llmmart
Git git clone https://github.com/microsoft/skills.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole microsoft/skills collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

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

# 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

@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

@router.post("/items", status_code=status.HTTP_201_CREATED)
async def create_item(item: ItemCreate) -> Item:
  ...

@router.delete("/items/{id}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_item(id: str) -> None:
  ...

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

Best Practices

  1. Pick def or async def per endpoint based on whether you call async I/O; do not call blocking I/O from an async def handler.
  2. Manage long-lived resources (DB pools, HTTP clients) in lifespan and inject via Depends; use with/async with for per-request resources.

Reference Files

File Contents
references/capabilities.md Additional non-hero capabilities, operation-group coverage, and production checklists.
Files (skills)
  • assets
    • template.py 4.6 KB
      Loading…
  • references
    • capabilities.md 934 B
      Loading…
  • SKILL.md 2.2 KB
    ---
    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.
    license: MIT
    metadata:
      author: Microsoft
      version: "1.0.0"
    ---
    
    # 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](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)
    async def create_item(item: ItemCreate) -> Item:
      ...
    
    @router.delete("/items/{id}", status_code=status.HTTP_204_NO_CONTENT)
    async def delete_item(id: str) -> None:
      ...
    ```
    
    ## 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
    
    ## Best Practices
    
    1. **Pick `def` or `async def` per endpoint based on whether you call async I/O; do not call blocking I/O from an `async def` handler.**
    2. **Manage long-lived resources (DB pools, HTTP clients) in `lifespan` and inject via `Depends`;** use `with`/`async with` for per-request resources.
    
    ## Reference Files
    
    | File | Contents |
    |------|----------|
    | [references/capabilities.md](references/capabilities.md) | Additional non-hero capabilities, operation-group coverage, and production checklists. |
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.