Files
AstrBot/astrbot/dashboard/api/personas.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

335 lines
9.8 KiB
Python

from __future__ import annotations
from typing import Any
from fastapi import APIRouter, Depends, Query, Request
from astrbot.dashboard.async_utils import run_maybe_async
from astrbot.dashboard.responses import ApiError, ok
from astrbot.dashboard.schemas import (
PersonaByIdRequest,
PersonaFolderRequest,
PersonaMoveRequest,
PersonaReorderRequest,
PersonaRequest,
)
from astrbot.dashboard.services.persona_service import (
PersonaService,
PersonaServiceError,
)
from .auth import AuthContext, require_dashboard_user, require_scope
router = APIRouter(tags=["Personas"])
legacy_router = APIRouter(
prefix="/api/persona",
tags=["Dashboard Personas"],
include_in_schema=False,
)
def get_service(request: Request) -> PersonaService:
return request.app.state.services.personas
async def require_persona_scope(request: Request) -> AuthContext:
return await require_scope(request, "persona")
async def _json_or_empty(request: Request) -> dict[str, Any]:
try:
data = await request.json()
except Exception:
return {}
return data if isinstance(data, dict) else {}
def _model_dict(payload) -> dict[str, Any]:
return payload.model_dump(exclude_none=True)
def _raise_persona_error(exc: PersonaServiceError | ValueError) -> None:
raise ApiError(str(exc)) from exc
async def _run(operation):
try:
result = await run_maybe_async(operation)
return ok(result)
except (PersonaServiceError, ValueError) as exc:
_raise_persona_error(exc)
@router.get("/personas/tree")
async def persona_tree(
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(service.get_folder_tree)
@router.get("/personas")
async def list_personas(
request: Request,
folder_id: str | None = Query(default=None),
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(
lambda: service.list_personas(folder_id, "folder_id" in request.query_params)
)
@router.post("/personas")
async def create_persona(
payload: PersonaRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.create_persona(_model_dict(payload)))
@router.get("/personas/by-id")
async def get_persona_by_id(
persona_id: str = Query(...),
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.get_persona_detail({"persona_id": persona_id}))
@router.put("/personas/by-id")
async def update_persona_by_id(
payload: PersonaByIdRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.update_persona(_model_dict(payload)))
@router.delete("/personas/by-id")
async def delete_persona_by_id(
persona_id: str = Query(...),
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.delete_persona({"persona_id": persona_id}))
@router.post("/personas/move")
async def move_persona(
payload: PersonaMoveRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.move_persona(_model_dict(payload)))
@router.post("/personas/reorder")
async def reorder_personas(
payload: PersonaReorderRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.reorder_items(_model_dict(payload)))
@router.get("/persona-folders")
async def list_persona_folders(
parent_id: str | None = Query(default=None),
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.list_folders(parent_id))
@router.post("/persona-folders")
async def create_persona_folder(
payload: PersonaFolderRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.create_folder(_model_dict(payload)))
@router.put("/persona-folders/{folder_id:path}")
async def update_persona_folder(
folder_id: str,
payload: PersonaFolderRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(
lambda: service.update_folder({"folder_id": folder_id, **_model_dict(payload)})
)
@router.delete("/persona-folders/{folder_id:path}")
async def delete_persona_folder(
folder_id: str,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.delete_folder({"folder_id": folder_id}))
@router.get("/personas/{persona_id:path}")
async def get_persona(
persona_id: str,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.get_persona_detail({"persona_id": persona_id}))
@router.put("/personas/{persona_id:path}")
async def update_persona(
persona_id: str,
payload: PersonaRequest,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(
lambda: service.update_persona(
{"persona_id": persona_id, **_model_dict(payload)}
)
)
@router.delete("/personas/{persona_id:path}")
async def delete_persona(
persona_id: str,
_auth: AuthContext = Depends(require_persona_scope),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.delete_persona({"persona_id": persona_id}))
@legacy_router.get("/list")
async def list_dashboard_personas(
request: Request,
folder_id: str | None = Query(default=None),
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
return await _run(
lambda: service.list_personas(folder_id, "folder_id" in request.query_params)
)
@legacy_router.post("/detail")
async def get_dashboard_persona_detail(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.get_persona_detail(body))
@legacy_router.post("/create")
async def create_dashboard_persona(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.create_persona(body))
@legacy_router.post("/update")
async def update_dashboard_persona(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.update_persona(body))
@legacy_router.post("/delete")
async def delete_dashboard_persona(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.delete_persona(body))
@legacy_router.post("/move")
async def move_dashboard_persona(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.move_persona(body))
@legacy_router.post("/reorder")
async def reorder_dashboard_personas(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.reorder_items(body))
@legacy_router.get("/folder/list")
async def list_dashboard_persona_folders(
parent_id: str | None = Query(default=None),
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
return await _run(lambda: service.list_folders(parent_id))
@legacy_router.get("/folder/tree")
async def get_dashboard_persona_folder_tree(
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
return await _run(service.get_folder_tree)
@legacy_router.post("/folder/detail")
async def get_dashboard_persona_folder_detail(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.get_folder_detail(body))
@legacy_router.post("/folder/create")
async def create_dashboard_persona_folder(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.create_folder(body))
@legacy_router.post("/folder/update")
async def update_dashboard_persona_folder(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.update_folder(body))
@legacy_router.post("/folder/delete")
async def delete_dashboard_persona_folder(
request: Request,
_username: str = Depends(require_dashboard_user),
service: PersonaService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.delete_folder(body))