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.

Sign up for GitHub

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

Jump to bottom

APIのバージョンを分ける #10601

Open
kakkokari-gtyih opened this issue Apr 12, 2023 · 11 comments
Open

APIのバージョンを分ける #10601

kakkokari-gtyih opened this issue Apr 12, 2023 · 11 comments
Labels
🧩API Interface between server and client 💬Discussion Being discussed or needs discussion ✨Feature This adds/improves/enhances a feature packages/backend Server side specific issue/PR

Comments

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Apr 12, 2023 •
edited
Loading

Summary

APIの仕様が頻繁に変わることを避けるために、/api/v1/等のルーティングを行い、旧仕様の実装をある程度の期間は保持できるようにする
@kakkokari-gtyih kakkokari-gtyih added the ✨Feature This adds/improves/enhances a feature label Apr 12, 2023
@EbiseLutica EbiseLutica added 🧩API Interface between server and client packages/backend Server side specific issue/PR 💬Discussion Being discussed or needs discussion labels Apr 12, 2023
@EbiseLutica
Copy link
Contributor

Misskey サードパーティアプリの数を増やすためには #8262 と並ぶほど必要だと思います

@acid-chicken
Copy link
Member

Misskey サードパーティアプリの数を増やすためには

でいうと #9523 が大事そう（というかそれでこれも一部満たされそう）

@saschanaz
Copy link
Member

/api/v1/等のルーティングを行い

エンドポイントごとバージョン付けるのはどうでしょう（/api/users/create/v2/)

@acid-chicken
Copy link
Member

GraphQL やりたい

@rinsuki
Copy link
Contributor

rinsuki commented Apr 30, 2023

fyi: Mastodon は /api/vX/... のような形式だが vX はエンドポイントごとに上がる

@kakkokari-gtyih
Copy link
Contributor Author

APIのバージョンを分けるというよりは、基本的な情報の取得だけでもStableにしたいので、Mastodon互換のAPIを導入するというのも手

@samunohito
Copy link
Member

#12507 (comment)

曰く、

/api/v2/notes/timeline とかになりそう

とのこと。

@samunohito
Copy link
Member

@syuilo
諸々の改善を実装するためにv2エンドポイントを生やさないと後方互換性を保てなさそうなケースが出てきているので、
上記のルールで進めてしまって良いですか…？

@syuilo
Copy link
Member

syuilo commented Aug 17, 2024

👍🏿

@Sayamame-beans
Copy link
Member

related: #14219

@samunohito
Copy link
Member

（閉じちゃっていいかしら…？）

@samunohito samunohito mentioned this issue Aug 17, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🧩API Interface between server and client 💬Discussion Being discussed or needs discussion ✨Feature This adds/improves/enhances a feature packages/backend Server side specific issue/PR
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@saschanaz @syuilo @rinsuki @EbiseLutica @acid-chicken @samunohito @Sayamame-beans @kakkokari-gtyih