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

236 lines
6.7 KiB
Python

from __future__ import annotations
from fastapi import APIRouter, Depends, Request
from fastapi.responses import JSONResponse
from astrbot.dashboard.async_utils import run_maybe_async
from astrbot.dashboard.responses import ApiError, ok
from astrbot.dashboard.schemas import T2iActiveTemplateRequest, T2iTemplateRequest
from astrbot.dashboard.services.t2i_service import T2iService, T2iServiceError
from .auth import AuthContext, require_dashboard_user, require_scope
router = APIRouter(tags=["Text To Image"])
legacy_router = APIRouter(
prefix="/api/t2i",
tags=["Dashboard Text To Image"],
include_in_schema=False,
)
def get_service(request: Request) -> T2iService:
return request.app.state.services.t2i
async def require_config_scope(request: Request) -> AuthContext:
return await require_scope(request, "config")
async def _json_or_empty(request: Request) -> dict:
try:
data = await request.json()
except Exception:
return {}
return data if isinstance(data, dict) else {}
def _raise_t2i_error(exc: T2iServiceError) -> None:
raise ApiError(str(exc), status_code=exc.status_code) from exc
def _response(
data=None,
*,
message: str | None = None,
status_code: int = 200,
):
payload = ok(data, message)
if status_code == 200:
return payload
return JSONResponse(payload, status_code=status_code)
async def _run(
operation,
*,
message: str | None = None,
status_code: int = 200,
result_as_message: bool = False,
):
try:
result = await run_maybe_async(operation)
if isinstance(result, tuple):
payload, result_message = result
return _response(payload, message=result_message)
if result_as_message:
return _response(message=str(result), status_code=status_code)
return _response(result, message=message, status_code=status_code)
except T2iServiceError as exc:
_raise_t2i_error(exc)
@router.get("/t2i/templates")
async def list_t2i_templates(
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(service.list_templates)
@router.post("/t2i/templates")
async def create_t2i_template(
payload: T2iTemplateRequest,
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(
lambda: service.create_template(payload.name, payload.content),
message="Template created successfully.",
status_code=201,
)
@router.get("/t2i/templates/active")
async def get_active_t2i_template(
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(service.get_active_template)
@router.put("/t2i/templates/active")
async def set_active_t2i_template(
payload: T2iActiveTemplateRequest,
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(
lambda: service.set_active_template(payload.name),
result_as_message=True,
)
@router.post("/t2i/templates/default/reset")
async def reset_default_t2i_template(
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(
service.reset_default_template,
result_as_message=True,
)
@router.get("/t2i/templates/{name:path}")
async def get_t2i_template(
name: str,
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(lambda: service.get_template(name))
@router.put("/t2i/templates/{name:path}")
async def update_t2i_template(
name: str,
payload: T2iTemplateRequest,
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(lambda: service.update_template(name, payload.content))
@router.delete("/t2i/templates/{name:path}")
async def delete_t2i_template(
name: str,
_auth: AuthContext = Depends(require_config_scope),
service: T2iService = Depends(get_service),
):
return await _run(
lambda: service.delete_template(name),
message="Template deleted successfully.",
)
@legacy_router.get("/templates")
async def list_dashboard_t2i_templates(
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
return await _run(service.list_templates)
@legacy_router.get("/templates/active")
async def get_dashboard_active_t2i_template(
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
return await _run(service.get_active_template)
@legacy_router.post("/templates/create")
async def create_dashboard_t2i_template(
request: Request,
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(
lambda: service.create_template(body.get("name"), body.get("content")),
message="Template created successfully.",
status_code=201,
)
@legacy_router.post("/templates/reset_default")
async def reset_dashboard_default_t2i_template(
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
return await _run(service.reset_default_template, result_as_message=True)
@legacy_router.post("/templates/set_active")
async def set_dashboard_active_t2i_template(
request: Request,
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(
lambda: service.set_active_template(body.get("name")),
result_as_message=True,
)
@legacy_router.get("/templates/{name:path}")
async def get_dashboard_t2i_template(
name: str,
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
return await _run(lambda: service.get_template(name))
@legacy_router.put("/templates/{name:path}")
async def update_dashboard_t2i_template(
name: str,
request: Request,
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.update_template(name, body.get("content")))
@legacy_router.delete("/templates/{name:path}")
async def delete_dashboard_t2i_template(
name: str,
_username: str = Depends(require_dashboard_user),
service: T2iService = Depends(get_service),
):
return await _run(
lambda: service.delete_template(name),
message="Template deleted successfully.",
)