菜单
Add new REST API endpoints to CachiBot's FastAPI backend following the project's conventions. Use this skill when adding API routes, endpoints, or REST resources — e.g., "add an API for reminders", "create a CRUD endpoint for bookmarks".
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/jhd3197/CachiBot --skill cachibot-api-route命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Create new frontend views and components for CachiBot's React+TypeScript UI with Zustand state management. Use this skill when building new pages, views, panels, or major UI components — e.g., "add a dashboard view", "create a logs panel", "build a new settings tab".
Add a complete full-stack entity to CachiBot spanning database table, repository, Pydantic models, API routes, TypeScript types, API client, and Zustand store. Use this skill when adding a new data entity or resource that needs persistence and CRUD across the entire stack — e.g., "add bookmarks", "add a reminders system", "create a templates feature".
Create new CachiBot agent plugins (tools) following the project's capability-gated plugin architecture. Use this skill when adding a new tool, capability, or plugin to the CachiBot agent system — e.g., "add a translate tool", "create a web scraping plugin", "add a new capability".
正在显示 SKILL.md
基于 SOC 职业分类
| name | cachibot-api-route |
| description | Add new REST API endpoints to CachiBot's FastAPI backend following the project's conventions. Use this skill when adding API routes, endpoints, or REST resources — e.g., "add an API for reminders", "create a CRUD endpoint for bookmarks". |
| metadata | {"author":"cachibot","version":"1.0"} |
Add new REST API endpoints following CachiBot's FastAPI patterns with Pydantic models, auth, and bot-scoping.
require_bot_access dependencyserver.pyCreate or extend models in cachibot/models/<domain>.py:
"""
<Domain> Models
Pydantic schemas for <domain> API.
"""
from pydantic import BaseModel
class YourItemCreate(BaseModel):
"""Request body for creating an item."""
name: str
description: str =
():
name: | =
description: | =
():
:
botId:
name:
description:
createdAt:
updatedAt:
() -> :
cls(
=row[],
botId=row[],
name=row[],
description=row[] ,
createdAt=row[],
updatedAt=row[],
)
Create cachibot/api/routes/<domain>.py:
"""
<Domain> API Routes
Endpoints for managing <domain resources>.
"""
from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel
from cachibot.api.auth import require_bot_access
from cachibot.models.auth import User
from cachibot.storage.repository import YourRepository
router = APIRouter(prefix="/api/bots/{bot_id}/<domain>", tags=["<domain>"])
# Repository instance
repo = YourRepository()
@router.get("")
async def list_items(
bot_id: str,
user: User = Depends(require_bot_access),
) -> list[YourItemResponse]:
"""List all items for a bot."""
items = await repo.get_items_by_bot(bot_id)
return [YourItemResponse.from_db(item) for item in items]
@router.post("", status_code=201)
async def create_item(
bot_id: str,
req: YourItemCreate,
user: User = Depends(require_bot_access),
) -> YourItemResponse:
"""Create a new item."""
import uuid
from datetime import datetime, timezone
now = datetime.now(timezone.utc).isoformat()
item_id = str(uuid.uuid4())
item = {
"id": item_id,
"bot_id": bot_id,
"name": req.name,
"description": req.description,
"created_at": now,
"updated_at": now,
}
await repo.save_item(item)
return YourItemResponse.from_db(item)
@router.get("/{item_id}")
async def get_item(
bot_id: str,
item_id: str,
user: User = Depends(require_bot_access),
) -> YourItemResponse:
"""Get a specific item."""
item = await repo.get_item(item_id)
if item is None or item["bot_id"] != bot_id:
raise HTTPException(status_code=404, detail="Item not found")
return YourItemResponse.from_db(item)
@router.put("/{item_id}")
async def update_item(
bot_id: str,
item_id: str,
req: YourItemUpdate,
user: User = Depends(require_bot_access),
) -> YourItemResponse:
"""Update an item."""
item = await repo.get_item(item_id)
if item is None or item["bot_id"] != bot_id:
raise HTTPException(status_code=404, detail="Item not found")
updates = req.model_dump(exclude_unset=True)
if updates:
from datetime import datetime, timezone
updates["updated_at"] = datetime.now(timezone.utc).isoformat()
await repo.update_item(item_id, updates)
updated = await repo.get_item(item_id)
return YourItemResponse.from_db(updated)
@router.delete("/{item_id}", status_code=204)
async def delete_item(
bot_id: str,
item_id: str,
user: User = Depends(require_bot_access),
) -> None:
"""Delete an item."""
item = await repo.get_item(item_id)
if item is None or item["bot_id"] != bot_id:
raise HTTPException(status_code=404, detail="Item not found")
await repo.delete_item(item_id)
Edit cachibot/api/server.py:
# Add import
from cachibot.api.routes import your_domain
# Add in create_app(), after existing routers:
app.include_router(your_domain.router, tags=["your_domain"])
Note: If the router already has a full prefix (e.g., /api/bots/{bot_id}/items), don't add prefix="/api" — that would double the prefix. Use prefix="/api" only for routers that don't have /api in their own prefix.
__init__.pyMake sure cachibot/api/routes/__init__.py exports the new module (or at minimum that it's importable from the routes package).
GET /api/bots/{bot_id}/<domain> → list
POST /api/bots/{bot_id}/<domain> → create (201)
GET /api/bots/{bot_id}/<domain>/{item_id} → get
PUT /api/bots/{bot_id}/<domain>/{item_id} → update
DELETE /api/bots/{bot_id}/<domain>/{item_id} → delete (204)
# Batch/action endpoints use underscore prefix:
POST /api/bots/{bot_id}/<domain>/_clear → bulk action
POST /api/bots/{bot_id}/<domain>/{id}/_archive → action on item
All bot-scoped endpoints use:
user: User = Depends(require_bot_access)
This validates the JWT and checks the user owns the bot.
For non-bot-scoped endpoints (global resources), use:
from cachibot.api.auth import require_user
user: User = Depends(require_user)
snake_case (e.g., bot_id, created_at)camelCase (e.g., botId, createdAt)from_db() classmethod on response models to convert# 404 for missing resources
raise HTTPException(status_code=404, detail="Item not found")
# 400 for invalid input
raise HTTPException(status_code=400, detail="Invalid name: must be non-empty")
# 409 for conflicts
raise HTTPException(status_code=409, detail="Item with this name already exists")
cachibot/models/cachibot/api/routes/APIRouter(prefix="/api/bots/{bot_id}/<domain>", tags=[...])user: User = Depends(require_bot_access)cachibot/api/server.pycachibot.api.routes