Files
AstrBot/astrbot/dashboard/api/bots.py
Weilong Liao 0d8e8682db refactor(core): migrate backend backbone from Quart to FastAPI and introduce more OpenAPI (#8688)
* refactor: migrate to fastapi

* structure refactor

* fix: pyright fix

* refactor: improve error handling and public messages in plugin services

* feat(api): refactor API client integration and enhance request handling

- Updated API client configuration to use a dedicated HTTP client.
- Introduced utility functions for generating options, queries, and form data for API requests.
- Refactored multiple API methods to utilize the new utility functions for improved consistency and readability.
- Renamed types for clarity and updated import statements accordingly.

feat(docs): add script to update OpenAPI JSON from YAML spec

- Created a Python script to convert OpenAPI YAML specification to JSON format.
- The script supports customizable input and output paths.
- Ensured the script handles directory creation for output paths and validates the YAML structure.

* fix

* feat(auth): implement rate limiting for v1 login endpoint and enhance request handling

* Refactor dashboard API routers to use legacy_router for backward compatibility

- Changed all instances of dashboard_router to legacy_router across multiple API modules including platform, plugins, providers, sessions, skills, stats, subagents, t2i, tools, updates, and asgi_runtime.
- Updated route definitions to ensure existing endpoints remain functional under the new router structure.
- Introduced support for Quart request context in asgi_runtime to enhance compatibility with existing Quart-based plugins.
- Added a test case to validate the functionality of the new Quart request context handling in plugin extensions.

* chore: remove cli test

* fix: update dashboard tests for fastapi migration

* chore: satisfy ruff checks

* fix: update openapi api key scopes

* fix: sync config scope chip selection

* fix: restore quart dependency

* docs: clarify quart plugin api compatibility

* docs: update openapi scope documentation

* fix: use singular skill openapi scope

* fix: hide update service exception details

* fix: address fastapi review comments

* fix: address dashboard review findings

* docs: revert unrelated package deployment changes

* docs: update agent api generation guidance

* feat: add plugin page web api helpers

* docs: add plugin page bridge demo

* fix: type plugin upload files

* fix: stabilize plugin page uploads

* fix: type plugin web request proxy

* docs: remove plugin page docs example

* fix: authenticate plugin page SSE bridge
2026-06-14 15:03:26 +08:00

254 lines
7.1 KiB
Python

from __future__ import annotations
from fastapi import APIRouter, Depends, Query, Request
from astrbot.dashboard.responses import error, ok
from astrbot.dashboard.schemas import BotConfigRequest, EnabledPatch
from astrbot.dashboard.services.config_service import BotConfigService
from .auth import AuthContext, require_scope
router = APIRouter(tags=["Bots"])
legacy_router = APIRouter(
prefix="/api/config/platform",
tags=["Dashboard Bots"],
include_in_schema=False,
)
async def require_bot_scope(request: Request) -> AuthContext:
return await require_scope(request, "bot")
def get_service(request: Request) -> BotConfigService:
return request.app.state.services.bots
async def _json_or_empty(request: Request) -> dict:
try:
data = await request.json()
except Exception:
return {}
return data if isinstance(data, dict) else {}
def _required_text(value: object, name: str) -> str:
text = str(value or "").strip()
if not text:
raise ValueError(f"Missing key: {name}")
return text
def _config_from_body(body: dict) -> dict:
config = body.get("config")
if isinstance(config, dict):
return config
return {
key: value
for key, value in body.items()
if key not in {"bot_id", "config", "enabled"}
}
def _alias_error(message: str):
return error(message)
@router.get("/bot-types")
async def list_bot_types(
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
return ok(service.list_bot_types())
@router.get("/bots")
async def list_bots(
enabled: bool | None = Query(default=None),
type_: str | None = Query(default=None, alias="type"),
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
return ok(service.list_bots(enabled=enabled, type_=type_))
@router.post("/bots")
async def create_bot(
payload: BotConfigRequest,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
await service.create_bot(payload.to_dashboard_config())
return ok(message="新增平台配置成功~")
@router.get("/bots/stats")
async def list_bot_stats(
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
return ok(service.get_bot_stats())
@router.get("/bots/by-id")
async def get_bot_by_id(
bot_id: str = Query(...),
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
return ok(service.get_bot(bot_id))
@router.put("/bots/by-id")
async def update_bot_by_id(
payload: BotConfigRequest,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
bot_id = _required_text(payload.bot_id, "bot_id")
await service.update_bot(
bot_id,
payload.to_dashboard_config(fallback_id=bot_id),
)
return ok(message="更新平台配置成功~")
@router.delete("/bots/by-id")
async def delete_bot_by_id(
bot_id: str = Query(...),
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
await service.delete_bot(bot_id)
return ok(message="删除平台配置成功~")
@router.patch("/bots/enabled")
async def set_bot_enabled_by_id(
payload: BotConfigRequest,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
bot_id = _required_text(payload.bot_id, "bot_id")
await service.set_bot_enabled(bot_id, bool(payload.enabled))
return ok(message="更新平台配置成功~")
@router.post("/bots/test")
async def test_bot_by_id(
payload: BotConfigRequest,
_auth: AuthContext = Depends(require_bot_scope),
):
bot_id = _required_text(payload.bot_id, "bot_id")
return ok({"id": bot_id, "status": "unsupported"})
@router.patch("/bots/{bot_id:path}/enabled")
async def set_bot_enabled(
bot_id: str,
payload: EnabledPatch,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
await service.set_bot_enabled(bot_id, payload.enabled)
return ok(message="更新平台配置成功~")
@router.post("/bots/{bot_id:path}/test")
async def test_bot(
bot_id: str,
_auth: AuthContext = Depends(require_bot_scope),
):
return ok({"id": bot_id, "status": "unsupported"})
@router.get("/bots/{bot_id:path}")
async def get_bot(
bot_id: str,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
return ok(service.get_bot(bot_id))
@router.put("/bots/{bot_id:path}")
async def update_bot(
bot_id: str,
payload: BotConfigRequest,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
await service.update_bot(bot_id, payload.to_dashboard_config(fallback_id=bot_id))
return ok(message="更新平台配置成功~")
@router.delete("/bots/{bot_id:path}")
async def delete_bot(
bot_id: str,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
await service.delete_bot(bot_id)
return ok(message="删除平台配置成功~")
@legacy_router.get("/list")
async def list_dashboard_alias_platforms(
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
return ok({"platforms": service.list_bots()["bots"]})
@legacy_router.post("/new")
async def create_dashboard_alias_platform(
payload: BotConfigRequest,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
try:
await service.create_bot(payload.to_dashboard_config())
return ok(message="新增平台配置成功~")
except ValueError as exc:
return _alias_error(str(exc))
@legacy_router.post("/update")
async def update_dashboard_alias_platform(
request: Request,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
body = await _json_or_empty(request)
bot_id = body.get("id")
config = body.get("config")
if not bot_id or not isinstance(config, dict):
return _alias_error("参数错误")
try:
await service.update_bot(
str(bot_id),
BotConfigRequest(config=config).to_dashboard_config(
fallback_id=str(bot_id)
),
)
return ok(message="更新平台配置成功~")
except ValueError as exc:
return _alias_error(str(exc))
@legacy_router.post("/delete")
async def delete_dashboard_alias_platform(
request: Request,
_auth: AuthContext = Depends(require_bot_scope),
service: BotConfigService = Depends(get_service),
):
body = await _json_or_empty(request)
bot_id = body.get("id")
if not bot_id:
return _alias_error("缺少参数 id")
try:
await service.delete_bot(str(bot_id))
return ok(message="删除平台配置成功~")
except ValueError as exc:
return _alias_error(str(exc))