From 123ccf96f1d444b6116b19f2044dd27fcb478dff Mon Sep 17 00:00:00 2001 From: YokiiroBW Date: Sun, 5 Jul 2026 10:53:00 +0800 Subject: [PATCH] feat: add astrbot route registry manifest --- adapters/webui_adapter.py | 5 +- backend/route_registry.py | 104 +++++++++++++++++++++++++++++++++++ tests/test_route_registry.py | 29 ++++++++++ 3 files changed, 137 insertions(+), 1 deletion(-) create mode 100644 backend/route_registry.py create mode 100644 tests/test_route_registry.py diff --git a/adapters/webui_adapter.py b/adapters/webui_adapter.py index a8d8ef7..045ffa7 100644 --- a/adapters/webui_adapter.py +++ b/adapters/webui_adapter.py @@ -8,7 +8,10 @@ without starting a standalone server. from __future__ import annotations from backend.services.web_hosting_service import WebHostingService +from backend.route_registry import route_manifest def get_web_mount_manifest() -> dict: - return WebHostingService().manifest() + manifest = WebHostingService().manifest() + manifest["api_routes"] = route_manifest() + return manifest diff --git a/backend/route_registry.py b/backend/route_registry.py new file mode 100644 index 0000000..51f61da --- /dev/null +++ b/backend/route_registry.py @@ -0,0 +1,104 @@ +"""Route registry manifest for AstrBot Web API mounting.""" + +from __future__ import annotations + +from dataclasses import dataclass +from typing import Any + + +@dataclass(frozen=True) +class RouteSpec: + method: str + endpoint: str + handler: str + permission: str + + def to_dict(self) -> dict[str, Any]: + return { + "method": self.method, + "endpoint": self.endpoint, + "handler": self.handler, + "permission": self.permission, + } + + +ROUTES: tuple[RouteSpec, ...] = ( + RouteSpec("GET", "ui/bootstrap", "backend.routes.ui_routes.get_ui_bootstrap", "read"), + RouteSpec("GET", "dashboard/summary", "backend.routes.dashboard_routes.get_dashboard_summary", "read"), + RouteSpec("GET", "profiles", "backend.routes.profile_routes.list_profiles", "read"), + RouteSpec("POST", "profiles", "backend.routes.profile_routes.create_profile", "write"), + RouteSpec("POST", "profiles/quick-draft", "backend.routes.profile_routes.create_quick_profile_draft", "read"), + RouteSpec("GET", "profiles/{profile_id}", "backend.routes.profile_routes.get_profile", "read"), + RouteSpec("PUT", "profiles/{profile_id}", "backend.routes.profile_routes.update_profile", "write"), + RouteSpec("DELETE", "profiles/{profile_id}", "backend.routes.profile_routes.delete_profile", "write"), + RouteSpec("GET", "profiles/{profile_id}/workflows", "backend.routes.workflow_routes.list_profile_workflows", "read"), + RouteSpec("POST", "profiles/{profile_id}/workflows", "backend.routes.workflow_routes.create_profile_workflow", "write"), + RouteSpec("GET", "workflows/{workflow_id}", "backend.routes.workflow_routes.get_workflow", "read"), + RouteSpec("PUT", "workflows/{workflow_id}", "backend.routes.workflow_routes.update_workflow", "write"), + RouteSpec("GET", "workflows/{workflow_id}/nodes", "backend.routes.node_routes.list_workflow_nodes", "read"), + RouteSpec("POST", "workflows/{workflow_id}/nodes", "backend.routes.node_routes.create_workflow_node", "write"), + RouteSpec("GET", "workflows/{workflow_id}/branches", "backend.routes.branch_routes.list_workflow_branches", "read"), + RouteSpec("POST", "workflows/{workflow_id}/branches", "backend.routes.branch_routes.create_workflow_branch", "write"), + RouteSpec("POST", "workflows/{workflow_id}/switch-branch", "backend.routes.branch_routes.switch_workflow_branch", "write"), + RouteSpec("GET", "workflows/{workflow_id}/history", "backend.routes.history_routes.list_workflow_history", "read"), + RouteSpec("GET", "nodes/{node_id}", "backend.routes.node_routes.get_node", "read"), + RouteSpec("PUT", "nodes/{node_id}", "backend.routes.node_routes.update_node", "write"), + RouteSpec("POST", "nodes/{node_id}/generate", "backend.routes.node_routes.generate_node", "write"), + RouteSpec("POST", "nodes/{node_id}/select-image", "backend.routes.node_routes.select_node_image", "write"), + RouteSpec("POST", "nodes/{node_id}/adopt-image", "backend.routes.history_routes.adopt_node_image", "write"), + RouteSpec("GET", "nodes/{node_id}/images", "backend.routes.image_routes.list_node_images", "read"), + RouteSpec("GET", "images/{image_id}", "backend.routes.image_routes.get_image", "read"), + RouteSpec("POST", "images/{image_id}/select", "backend.routes.image_routes.select_image", "write"), + RouteSpec("POST", "images/{image_id}/unselect", "backend.routes.image_routes.unselect_image", "write"), + RouteSpec("POST", "images/{image_id}/archive", "backend.routes.image_routes.archive_image", "write"), + RouteSpec("DELETE", "images/{image_id}", "backend.routes.image_routes.delete_image", "write"), + RouteSpec("GET", "jobs", "backend.routes.job_routes.list_jobs", "read"), + RouteSpec("GET", "jobs/{task_id}", "backend.routes.job_routes.get_job", "read"), + RouteSpec("POST", "jobs/{task_id}/cancel", "backend.routes.job_routes.cancel_job", "write"), + RouteSpec("POST", "jobs/{task_id}/retry", "backend.routes.job_routes.retry_job", "write"), + RouteSpec("GET", "settings/schema", "backend.routes.settings_routes.get_settings_schema", "read"), + RouteSpec("GET", "settings/current", "backend.routes.settings_routes.get_current_settings", "read"), + RouteSpec("POST", "settings/validate", "backend.routes.settings_routes.validate_settings", "config"), + RouteSpec("POST", "settings/diff", "backend.routes.settings_routes.diff_settings", "config"), + RouteSpec("POST", "settings/save", "backend.routes.settings_routes.save_settings", "config"), + RouteSpec("POST", "settings/reload", "backend.routes.settings_routes.reload_settings", "config"), + RouteSpec("GET", "settings/export", "backend.routes.settings_routes.export_settings", "config"), + RouteSpec("POST", "settings/import", "backend.routes.settings_routes.import_settings", "config"), + RouteSpec("GET", "storage/status", "backend.routes.storage_routes.get_storage_status", "read"), + RouteSpec("GET", "media/sign", "backend.routes.media_routes.sign_media", "read"), + RouteSpec("GET", "media/fetch", "backend.routes.media_routes.fetch_media", "public_token"), + RouteSpec("GET", "material-categories", "backend.routes.material_routes.list_material_categories", "read"), + RouteSpec("POST", "material-categories", "backend.routes.material_routes.create_material_category", "materials"), + RouteSpec("GET", "materials", "backend.routes.material_routes.list_materials", "read"), + RouteSpec("POST", "materials", "backend.routes.material_routes.create_material", "materials"), + RouteSpec("POST", "materials/upload", "backend.routes.material_routes.upload_material", "materials"), + RouteSpec("POST", "materials/{material_id}/recognize", "backend.routes.material_routes.recognize_material", "materials"), + RouteSpec("POST", "materials/{material_id}/confirm", "backend.routes.material_routes.confirm_material", "materials"), + RouteSpec("GET", "profiles/{profile_id}/wardrobe", "backend.routes.wardrobe_routes.list_wardrobe_items", "read"), + RouteSpec("POST", "profiles/{profile_id}/wardrobe/import-material", "backend.routes.wardrobe_routes.import_wardrobe_material", "materials"), + RouteSpec("POST", "profiles/{profile_id}/wardrobe/match", "backend.routes.wardrobe_routes.match_wardrobe", "read"), + RouteSpec("POST", "integrations/private-companion/daily-outfit", "backend.routes.integration_routes.private_companion_daily_outfit", "read"), + RouteSpec("GET", "logs/generation", "backend.routes.log_routes.get_generation_logs", "read"), + RouteSpec("GET", "logs/workflows", "backend.routes.log_routes.get_workflow_logs", "read"), + RouteSpec("GET", "logs/errors", "backend.routes.log_routes.get_error_logs", "read"), + RouteSpec("GET", "logs/integrations", "backend.routes.log_routes.get_integration_logs", "read"), + RouteSpec("GET", "security/audit-logs", "backend.routes.log_routes.get_audit_logs", "config"), + RouteSpec("GET", "api-discovery/dialects", "backend.routes.api_discovery_routes.list_dialects", "read"), + RouteSpec("POST", "api-discovery/probe-provider", "backend.routes.api_discovery_routes.probe_provider", "config"), + RouteSpec("GET", "api-discovery/capabilities", "backend.routes.api_discovery_routes.list_capabilities", "read"), + RouteSpec("POST", "api-discovery/validate-render-plan", "backend.routes.api_discovery_routes.validate_render_plan", "read"), + RouteSpec("GET", "web/manifest", "backend.routes.web_routes.get_web_manifest", "read"), +) + + +def route_manifest() -> list[dict[str, Any]]: + return [route.to_dict() for route in ROUTES] + + +def assert_unique_routes() -> None: + seen: set[tuple[str, str]] = set() + for route in ROUTES: + key = (route.method, route.endpoint) + if key in seen: + raise RuntimeError(f"duplicate route: {route.method} {route.endpoint}") + seen.add(key) diff --git a/tests/test_route_registry.py b/tests/test_route_registry.py new file mode 100644 index 0000000..bf86905 --- /dev/null +++ b/tests/test_route_registry.py @@ -0,0 +1,29 @@ +from __future__ import annotations + +import unittest + +from adapters.webui_adapter import get_web_mount_manifest +from backend.route_registry import ROUTES, assert_unique_routes, route_manifest + + +class RouteRegistryTests(unittest.TestCase): + def test_route_manifest_is_unique_and_contains_core_endpoints(self): + assert_unique_routes() + routes = route_manifest() + keys = {(route["method"], route["endpoint"]) for route in routes} + + self.assertIn(("GET", "ui/bootstrap"), keys) + self.assertIn(("POST", "nodes/{node_id}/generate"), keys) + self.assertIn(("GET", "security/audit-logs"), keys) + self.assertIn(("POST", "api-discovery/probe-provider"), keys) + self.assertEqual(len(routes), len(ROUTES)) + + def test_webui_adapter_manifest_includes_api_routes(self): + manifest = get_web_mount_manifest() + + self.assertIn("standalone_web", manifest) + self.assertTrue(any(route["endpoint"] == "dashboard/summary" for route in manifest["api_routes"])) + + +if __name__ == "__main__": + unittest.main()