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

122 lines
3.4 KiB
Python

from __future__ import annotations
from typing import Any
from fastapi import APIRouter, Depends, Request
from astrbot.dashboard.asgi_runtime import DashboardRequest
from astrbot.dashboard.async_utils import run_maybe_async
from astrbot.dashboard.responses import ApiError, ok
from astrbot.dashboard.schemas import BotRegistrationRequest
from astrbot.dashboard.services.platform_service import (
PlatformService,
PlatformServiceError,
)
from .auth import AuthContext, require_dashboard_user, require_scope
router = APIRouter(tags=["Platforms"])
legacy_router = APIRouter(
prefix="/api/platform",
tags=["Dashboard Platforms"],
include_in_schema=False,
)
def get_service(request: Request) -> PlatformService:
return request.app.state.services.platforms
async def require_config_scope(request: Request) -> AuthContext:
return await require_scope(request, "config")
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 _raise_platform_error(exc: PlatformServiceError) -> None:
raise ApiError(str(exc), status_code=exc.status_code) from exc
def _model_dict(payload) -> dict[str, Any]:
return payload.model_dump(exclude_none=True)
async def _run(operation):
try:
result = await run_maybe_async(operation)
return ok(result)
except PlatformServiceError as exc:
_raise_platform_error(exc)
@router.post("/bot-types/{bot_type}/registration")
async def register_bot_type(
bot_type: str,
payload: BotRegistrationRequest,
_auth: AuthContext = Depends(require_config_scope),
service: PlatformService = Depends(get_service),
):
return await _run(
lambda: service.handle_platform_registration(bot_type, _model_dict(payload))
)
@router.get("/webhooks/platforms/{webhook_uuid}")
async def verify_platform_webhook(
webhook_uuid: str,
request: Request,
service: PlatformService = Depends(get_service),
):
return await _run(
lambda: service.handle_webhook_callback(webhook_uuid, DashboardRequest(request))
)
@router.post("/webhooks/platforms/{webhook_uuid}")
async def receive_platform_webhook(
webhook_uuid: str,
request: Request,
service: PlatformService = Depends(get_service),
):
return await _run(
lambda: service.handle_webhook_callback(webhook_uuid, DashboardRequest(request))
)
@legacy_router.api_route("/webhook/{webhook_uuid}", methods=["GET", "POST"])
async def dashboard_platform_webhook(
webhook_uuid: str,
request: Request,
service: PlatformService = Depends(get_service),
):
return await _run(
lambda: service.handle_webhook_callback(webhook_uuid, DashboardRequest(request))
)
@legacy_router.get("/stats")
async def get_dashboard_platform_stats(
_username: str = Depends(require_dashboard_user),
service: PlatformService = Depends(get_service),
):
return await _run(service.get_platform_stats)
@legacy_router.post("/registration/{platform_type}")
async def handle_dashboard_platform_registration(
platform_type: str,
request: Request,
_username: str = Depends(require_dashboard_user),
service: PlatformService = Depends(get_service),
):
payload = await _json_or_empty(request)
return await _run(
lambda: service.handle_platform_registration(platform_type, payload)
)