Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
3 tasks
takana-v opened this issue Nov 28, 2024 · 2 comments
Labels
機能向上 要議論 実行する前に議論が必要そうなもの

Comments

@takana-v
Copy link
Member

takana-v commented Nov 28, 2024

内容

プリセット周りのエンドポイントは、「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の種類/ディストリ/バージョン

  • Windows
  • macOS
  • Linux

その他

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

@takana-v takana-v added 機能向上 要議論 実行する前に議論が必要そうなもの labels Nov 28, 2024
@sevenc-nanashi
Copy link
Member

関連しそう:VOICEVOX/voicevox_project#18

@Hiroshiba
Copy link
Member

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
機能向上 要議論 実行する前に議論が必要そうなもの
Projects
None yet
Development

No branches or pull requests

3 participants