追加: GET / API にポータルページを配置

[tarepan]

内容

概要: GET / API にポータルページを配置した

API が提供する GET /setting と GET /docs およびライセンスへのリンクを含むポータルページを実装した。

関連 Issue

resolve #778

スクリーンショット・動画など

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	283	122
voicevox_engine/init.py	1	0
voicevox_engine/app/init.py	0	0
voicevox_engine/app/dependencies.py	9	0
voicevox_engine/app/routers/init.py	0	0
voicevox_engine/app/routers/preset.py	37	4
voicevox_engine/app/routers/setting.py	23	3
voicevox_engine/app/routers/speaker.py	59	5
voicevox_engine/app/routers/tts_pipeline.py	121	29
voicevox_engine/app/routers/user_dict.py	60	29
voicevox_engine/cancellable_engine.py	97	75
voicevox_engine/core/init.py	0	0
voicevox_engine/core/core_adapter.py	81	6
voicevox_engine/core/core_initializer.py	60	30
voicevox_engine/core/core_wrapper.py	228	160
voicevox_engine/dev/init.py	0	0
voicevox_engine/dev/core/init.py	0	0
voicevox_engine/dev/core/mock.py	65	2
voicevox_engine/dev/tts_engine/init.py	0	0
voicevox_engine/dev/tts_engine/mock.py	28	0
voicevox_engine/engine_manifest/EngineManifest.py	36	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	11	0
voicevox_engine/engine_manifest/init.py	0	0
voicevox_engine/library_manager.py	92	4
voicevox_engine/metas/Metas.py	36	0
voicevox_engine/metas/MetasStore.py	28	1
voicevox_engine/metas/init.py	0	0
voicevox_engine/model.py	180	3
voicevox_engine/morphing.py	72	4
voicevox_engine/preset/Preset.py	13	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	82	2
voicevox_engine/preset/init.py	0	0
voicevox_engine/setting/Setting.py	9	0
voicevox_engine/setting/SettingLoader.py	20	0
voicevox_engine/setting/init.py	0	0
voicevox_engine/tts_pipeline/init.py	0	0
voicevox_engine/tts_pipeline/kana_converter.py	88	1
voicevox_engine/tts_pipeline/mora_mapping.py	7	0
voicevox_engine/tts_pipeline/phoneme.py	34	0
voicevox_engine/tts_pipeline/text_analyzer.py	146	6
voicevox_engine/tts_pipeline/tts_engine.py	268	9
voicevox_engine/user_dict/part_of_speech_data.py	5	0
voicevox_engine/user_dict/user_dict.py	146	12
voicevox_engine/utility/init.py	0	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_utility.py	6	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	13	0
voicevox_engine/utility/path_utility.py	26	6
voicevox_engine/utility/run_utility.py	10	7
TOTAL	2527	521

[Hiroshiba]

良いですね！！！

[tarepan]

マルチエンジン絡みの質問です。

API は VV API としてマルチエンジンに配慮した設計が必要、と認識しています。同時に、内部実装はエンジンごとに違うので特段の配慮不要、とも認識しています。
/ API は「HTMLを返す」が API 仕様で、HTMLの記述内容は内部実装依存です。
上記レビューでの埋め込みリンクも後者に属すると思うのですが、どの辺が懸念点でしょうか？

[Hiroshiba]

たしかに懸念点が不明瞭でした！

コードを読まないとマルチエンジンのためにどこを変更したら良いかわからない点かなと！
あとマルチエンジンのドキュメントに「どこを変えれば良いか」とか案内することとかを考えると、変更しないといけないとこは集約されてた方が説明しやすい、とか…！

[tarepan]

エンジン固有設定は設定ファイルへ集約できるなら集約する（例: engine_manifest.json）、が基本方針ということですね。理解しました。

ライセンス情報はこちら（#778 (comment) ）の suggestion に従って追加していますが、ライセンス情報はポータルに無しにするのも手と考えています。

ライセンス情報をいれる場合、エンジンごとに要件が異なるため使い回せるコードとするのが難しいと考えます。
例えば企業製有料 ENGINE を作る場合、製品版ソフトウェアのライセンス（=利用規約）はホームページ上に掲載した利用規約へのリンクにしたいです（サービス規約更新の柔軟性が上がる）。となると現行の engine_manifest.json には相当する attribute が無さそうな気がします。
集約できないのであれば、エンジン間で使い回せない前提で割り切って VOICEVOX ENGINE 向けにリンクをハードコードしても良いと考えます。

どちらの方針がよいでしょうか？

[Hiroshiba]

@tarepan なるほどです！

無しで良いと思います！

一方で別にあっても良いと思います。
ここに利用規約が書いてるのは別に必ず踏んでほしいという意図ではなく、ちょっと確認したいときに便利くらいの感じになると思います。

載せる場合、利用規約はまあmanifestに置いてあるterms_of_serviceのmarkdownを表示する形が丸い気がしました。
リンクが良い場合はこのmarkdownにリンクを書いてもらう感じになる気がします。
よりリッチな案内もできるかもですが、まあそういうのはissueやPRが立ってからで良いかなと。

載せても載せなくてもどちらでも良いと思います！検討ありがとうございます！！

[tarepan]

無しで良いと思います

👍️
削除します。

リンクが良い場合はこのmarkdownにリンクを書いてもらう感じ

👍️
なるほどです、合理的な方法だと思います。
将来実装することがあればこちらが良さそうです、提案ありがとうございます！

---

@Hiroshiba
全指摘箇所の反映・テストパスを確認しました。Re-review よろしくお願いします。

[Hiroshiba]

LGTM！！

ちょっと一部だけ調整させていただきます！