search

VOICEVOX / voicevox_engine

無料で使える中品質なテキスト読み上げソフトウェア、VOICEVOXの音声合成エンジン
https://voicevox.hiroshiba.jp/
Other
1.32k stars 200 forks source link

プリセット周りのエンドポイントをREST APIの原則に沿ったメソッドに変更する #1494

Open takana-v opened 3 days ago

takana-v commented 3 days ago

内容

プリセット周りのエンドポイントは、「delete_presetにPOST」など、RESTなAPIではありません。 これを、REST APIの原則に沿ったメソッドに変更することを提案します。 メリットもデメリットもあると思われるので、「要議論」ラベルを付けておきます。

Pros 良くなる点

RESTなAPIになり、分かりやすくなる

Cons 悪くなる点

Deprecatedとして扱う手間がかかる

実現方法

今までのエンドポイントをDeprecated扱いとし、REST APIに沿ったメソッドで定義されるエンドポイントを作成する https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#deprecate-a-path-operation

VOICEVOXのバージョン

0.21.1

OSの種類/ディストリ/バージョン

その他

APIのドキュメントでは、Deprecatedなエンドポイントはグレーで表示されるようです。 image

sevenc-nanashi commented 3 days ago

関連しそう：https://github.com/VOICEVOX/voicevox_project/issues/18

Hiroshiba commented 3 days ago

確かにRESTになってない気がしますね！ 以前のやつはdeprecatedとして実装しつつリネームする、で良さそうに思います！

@sevenc-nanashi さんの書いてくださったタスクリストにもエンジンのpreset系のAPIとuser_dict_word系のAPIでdeleteやupdateのインターフェイスが異なるがありますね！（忘れてました） 今はdeprecatedにしておいて、超破壊的変更の時に消しますか！ まあこれくらいなら1年後ぐらいに消してもいいかもしれない。