整理: ポータル機能を router へ分離 (#1221)

* refactor: ポータル機能を router へ分離 * refactor: single API テストを分離 * fix: リファクタリングの混入を削除 * fix: `portal` → `portal_page` にリネーム
VOICEVOX · May 17, 2024 · 81a0a2f · 81a0a2f
1 parent 57fdf1e
commit 81a0a2f
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 22 deletions.
diff --git a/test/e2e/__snapshots__/test_openapi/test_OpenAPIの形が変わっていないことを確認.json b/test/e2e/__snapshots__/test_openapi/test_OpenAPIの形が変わっていないことを確認.json
diff --git a/...ngle_api/__snapshots__/test_get_root.ambr → ...tal_page/__snapshots__/test_get_root.ambr b/...ngle_api/__snapshots__/test_get_root.ambr → ...tal_page/__snapshots__/test_get_root.ambr
diff --git a/test/e2e/single_api/test_get_root.py → ...e/single_api/portal_page/test_get_root.py b/test/e2e/single_api/test_get_root.py → ...e/single_api/portal_page/test_get_root.py
diff --git a/voicevox_engine/app/application.py b/voicevox_engine/app/application.py
@@ -1,7 +1,6 @@
 from pathlib import Path
 
 from fastapi import FastAPI, HTTPException
-from fastapi.responses import HTMLResponse
 
 from voicevox_engine import __version__
 from voicevox_engine.app.dependencies import deprecated_mutable_api
@@ -10,6 +9,7 @@
 from voicevox_engine.app.routers.engine_info import generate_engine_info_router
 from voicevox_engine.app.routers.library import generate_library_router
 from voicevox_engine.app.routers.morphing import generate_morphing_router
+from voicevox_engine.app.routers.portal_page import generate_portal_page_router
 from voicevox_engine.app.routers.preset import generate_preset_router
 from voicevox_engine.app.routers.setting import generate_setting_router
 from voicevox_engine.app.routers.speaker import generate_speaker_router
@@ -101,25 +101,7 @@ def get_core(core_version: str | None) -> CoreAdapter:
         generate_engine_info_router(get_core, cores, engine_manifest_data)
     )
     app.include_router(generate_setting_router(setting_loader, engine_manifest_data))
-
-    @app.get("/", response_class=HTMLResponse, tags=["その他"])
-    async def get_portal() -> str:
-        """ポータルページを返します。"""
-        engine_name = engine_manifest_data.name
-
-        return f"""
-        <html>
-            <head>
-                <title>{engine_name}</title>
-            </head>
-            <body>
-                <h1>{engine_name}</h1>
-                {engine_name} へようこそ！
-                <ul>
-                    <li><a href='/setting'>設定</a></li>
-                    <li><a href='/docs'>API ドキュメント</a></li>
-        </ul></body></html>
-        """
+    app.include_router(generate_portal_page_router(engine_manifest_data))
 
     app = configure_openapi_schema(app)
 

diff --git a/voicevox_engine/app/routers/portal_page.py b/voicevox_engine/app/routers/portal_page.py
@@ -0,0 +1,32 @@
+"""ポータルページ機能を提供する API Router"""
+
+from fastapi import APIRouter
+from fastapi.responses import HTMLResponse
+
+from voicevox_engine.engine_manifest.EngineManifest import EngineManifest
+
+
+def generate_portal_page_router(engine_manifest_data: EngineManifest) -> APIRouter:
+    """ポータルページ API Router を生成する"""
+    router = APIRouter()
+
+    @router.get("/", response_class=HTMLResponse, tags=["その他"])
+    async def get_portal_page() -> str:
+        """ポータルページを返します。"""
+        engine_name = engine_manifest_data.name
+
+        return f"""
+        <html>
+            <head>
+                <title>{engine_name}</title>
+            </head>
+            <body>
+                <h1>{engine_name}</h1>
+                {engine_name} へようこそ！
+                <ul>
+                    <li><a href='/setting'>設定</a></li>
+                    <li><a href='/docs'>API ドキュメント</a></li>
+        </ul></body></html>
+        """
+
+    return router