菜单
Use when adding a new HTTP endpoint to this project's FastAPI backend. Covers the router module, request and response schemas, dependency wiring, router registration, the health surface, and the API test.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | add-api-endpoint |
| description | Use when adding a new HTTP endpoint to this project's FastAPI backend. Covers the router module, request and response schemas, dependency wiring, router registration, the health surface, and the API test. |
Add an HTTP route to the FastAPI backend. Endpoints live under
app/components/backend/api/ and are mounted by a single registration file, so
a route is not reachable until it is both defined and registered.
Use when adding or changing an HTTP route the backend serves.
Do NOT use for background work (that is a job, not a request) or for scheduled
work. Do NOT hand-add a whole new service or component this way; use the aegis
CLI for that.
app/components/backend/api/: endpoint modules live here. Add <name>.py
with an APIRouter, or a <name>/router.py package for a group of routes.app/components/backend/api/routing.py: register the router here (import it
and mount it with app.include_router(...)).app/components/backend/api/deps.py: shared FastAPI dependencies; add one
here if the endpoint needs a reusable dependency.app/components/backend/api/health.py: the health surface; wire a check if
the endpoint fronts a new subsystem.tests/api/: add test_<name>_endpoints.py.tests/api/test_<name>_endpoints.py, driving
the route through the test client. Confirm it fails for the right reason (the
route does not exist yet).app/components/backend/api/ with an
APIRouter() and the route handlers as async def.app/components/backend/api/routing.py: import it and
call app.include_router(...).app/components/backend/api/deps.py, and wire
a health check in health.py if the endpoint fronts a new subsystem.make check: lint, typecheck, and test.routing.py returns 404; the
registration step is what makes the route reachable.def; a blocking call inside one stalls the event
loop and slows every request, so use the async client or run blocking work off
the loop.Use when cutting a release of the aegis-stack package. Covers the version-bump file set, the changelog cut, the three release gates, TestPyPI rc verification, and the tag-push mechanics that trigger the publish workflow.
Use when adding a command to this project's own CLI (the app CLI under app/cli/, not the aegis tool). Covers the command module, Typer registration, the sync-plus-asyncio.run rule, and i18n strings.
Use when adding or changing a database model in this project. Covers the SQLModel table definition, the alembic autogenerate migration flow, and the query rules that keep access performant.
Use when adding a job that runs on a schedule (periodic or at a fixed time) in this project. Covers writing the task function and registering it with the scheduler.
Use when adding or removing a capability (a component or service) in this project, or pulling framework updates. Covers the aegis add, remove, and update commands and what each one changes.
Use when an API endpoint in this project must require an authenticated user or a specific role. Covers the auth dependencies, attaching them to a route, and the session and cookie rules.