菜单
Scaffold a new API endpoint with request/response Pydantic schemas, service function, route handler, and a pytest test — following the project's layered layout. Invoke when the user asks to add an endpoint, route, or API method.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Scaffold a new HTTP handler with service function, store method (if needed), and table-driven test, following the project's internal/{api,service,store} layout. Invoke when the user asks to add an endpoint, handler, or route.
Scaffold a new React component with matching test file and consistent folder layout, following the project's conventions in src/features or src/components. Invoke when the user asks to create, scaffold, or add a new component.
Write React Testing Library tests for an existing component, following the project's RTL conventions (prefer role/label queries, mock at network boundary, no act()). Invoke when the user asks to test, add tests for, or cover a component.
Run this repo's documentation and shell quality gates (shellcheck, markdownlint, lint-claude-md) the same way CI runs them. Invoke before opening a PR, or when the user asks to lint, validate, or pre-flight the docs.
Generate or update CHANGELOG.md with an entry for the unreleased changes since the last git tag. Invoke when the user asks to cut a release, update the changelog, or summarize changes since v-something.
Write a pull-request title and body from the current branch's commits and diff against the base branch. Invoke when the user asks to open a PR, draft a PR description, or summarize a branch.
| name | api-endpoint |
| description | Scaffold a new API endpoint with request/response Pydantic schemas, service function, route handler, and a pytest test — following the project's layered layout. Invoke when the user asks to add an endpoint, route, or API method. |
| allowed-tools | Read, Write, Edit, Glob, Grep |
Scaffold one new endpoint across the layers the project already uses. Don't invent a layer the codebase doesn't have.
POST /users),
what it does, and the response shape. Do not guess.app/api/ (or the project's equivalent) to
match: router setup, dependency injection, error handling, test file
layout. If no sibling exists, use the shape below.app/schemas/<resource>.py — request + response Pydantic models.
If the file exists, add the new models; do not rewrite it.app/services/<resource>.py — the pure-ish function that does the
work. No request/response handling here.app/api/<resource>.py — the route handler. Call the service, map
domain exceptions to HTTP codes.tests/api/test_<resource>.py — one happy-path test and one failure
test (invalid input → 422, or domain error → mapped status).app/api/__init__.py (or the project's
equivalent) only if adding a new resource file.ruff format and ruff check on the files you touched. Report any
remaining lint errors; do not auto-fix mypy errors without showing the
user the diff.# app/schemas/widget.py
from pydantic import BaseModel, Field
class WidgetCreate(BaseModel):
name: str = Field(min_length=1, max_length=80)
class WidgetOut(BaseModel):
id: int
name: str
# app/services/widgets.py
from app.schemas.widget import WidgetCreate, WidgetOut
def create_widget(db, payload: WidgetCreate) -> WidgetOut:
widget = Widget(name=payload.name)
db.add(widget); db.flush()
return WidgetOut(id=widget.id, name=widget.name)
# app/api/widgets.py
from fastapi import APIRouter, Depends
from app.schemas.widget import WidgetCreate, WidgetOut
from app.services import widgets as service
router = APIRouter(prefix="/widgets", tags=["widgets"])
@router.post("", response_model=WidgetOut, status_code=201)
def create(payload: WidgetCreate, db = Depends(get_db)) -> WidgetOut:
return service.create_widget(db, payload)
tests/api/ mirroring the source path.