BoostryJP / ibet-Wallet-API

A powerful API suite for seamlessly building ibet blockchain wallet systems 🛠
https://ibet.jp/ibet-for-fin
Apache License 2.0
9 stars 0 forks source link

[FEATURE] Integrate v2/v3 APIs and change API versioning policy #1191

Closed YoshihitoAso closed 2 years ago

YoshihitoAso commented 2 years ago

Is your feature request related to a problem? Please describe.

The current API versioning policy is to create a /v3 API when backward compatibility cannot be maintained, and to guarantee functionality for a certain period of time for the /v2 API.

However, considering the usage of ibet-Wallet-API, the impact of API interface changes when upgrading is not so high, while supporting multiple versions seems to be too much of a maintenance burden.

現在のAPIバージョニングの方針では、後方互換性を保てない場合には /v3 API を作成し、/v2 API については一定期間機能を保証している。 しかし、ibet-Wallet-APIの利用方法を考えると、アップグレードする際のAPIインターフェース変更の影響はそれほど高くなく、一方で複数バージョンのサポートはメンテナンスの負荷が高すぎるように思われる。

Describe the solution you'd like

v2/v3 APIを統合し、APIのバージョニングの方針を変更する。 後方互換性を保てないインターフェース修正は、全て破壊的変更として取り扱う。