Box SDKは、Box APIと連携するための主要な手段です。Boxのチームは可能な限り最適な開発者エクスペリエンスを提供するために尽力しています。
1か月前、Boxでは、Box SDKの配布方法の変更を発表し、生成されたSDKパッケージのみを含む新しいメジャーバージョン (v10.0.0) を導入しました。また、移行作業を簡単にすることを目標に、以前は個別のアーティファクトとして開発されていた生成されたBoxの次世代SDKとBoxコアSDKを統合した新しいメジャーバージョンをさらにリリースする予定です。
この記事では、Box SDKのバージョンとプロジェクトに推奨されるパスの詳細を説明します。
概要
Boxの次世代SDKは、APIの全面的なサポート、迅速な更新、埋め込みドキュメント、強化された便利なメソッドにより改善された開発者エクスペリエンスを提供するために作成されました。それらのアーキテクチャは、生成プロセスを通じて、サポートされているすべてのプログラミング言語で統一されました。最新リリースにより、これまで手動で管理されていたBoxコアSDKパッケージで直接、上記のメリットを活用できます。
BoxコアSDKパッケージは現在、サポート対象の2つのメジャーバージョンで利用できます。
- SDKのアーティファクトごとにシーケンシャルなバージョン管理に従っているバージョン。これには、2つのパッケージ (手動で管理されているパッケージと生成されたパッケージ) が含まれます。共存するこれらのパッケージにより、最新のBox APIの機能を簡単に使用できるようになるほか、生成されたスタンドアロンのパッケージ (バージョン10以降) への段階的な移行がサポートされます。
- バージョン10 (Box SDKのすべてのアーティファクトで一貫しているバージョン番号)。これには、生成されたパッケージのみが含まれ、重大な変更が導入されます。
BoxコアSDKの直近2つのメジャーバージョン
変更された点について理解を深めるために、例としてBox Python SDKを見てみましょう。
- Python SDK v4には、手動で管理されているパッケージ (boxsdk) と生成されたパッケージ (box_sdk_gen) が含まれています。
- Python SDK v10には、生成されたパッケージ (box_sdk_gen) のみが含まれています。
- Pythonの次世代SDKのアーティファクトは公式サポートが終了したため、現在、その機能はv4とv10の両方でbox_sdk_genを通じて利用できます。
最終的には、v10.0.0以降に移行することをお勧めします。各BoxコアSDKの統合バージョンのサポートは2027年も継続されます。すべてのBox SDKに関する詳細なバージョンの内訳については、Developerドキュメントを参照してください。
BoxコアSDKをベースにしたプロジェクトの最初のステップは、手動で管理されているパッケージと生成されたパッケージを統合したバージョンへのアップグレードです。作業を開始するには、以下の移行ガイド (英語) を参照してください。
次に、生成されたパッケージへの移行に役立つ、各SDKの詳細な移行ガイド (英語) を以下に示します。
- Python: boxsdkからbox_sdk_genパッケージに移行
- Node: box-node-sdkからsdk-genに移行
- Java: com.box.sdkからcom.box.sdkgenパッケージに移行
- .NET: Box.V2モジュールからBox.Sdk.Genモジュールに移行
- Swift: BoxSDKモジュールからBoxSdkGenモジュールに移行
Boxの次世代SDKの公式サポート終了
日本時間2025年9月18日をもって、Boxの次世代SDKは、個別のアーティファクトとしてサポートされなくなりました。既存のコードは、変更しなくても引き続き動作します。Boxの次世代SDKをベースにしたアプリケーションは引き続きご利用いただけますが、新機能、更新、バグ修正は提供されなくなります。
新機能や更新を含む、今後の開発はすべて、BoxコアSDKを通じて提供されます。スタンドアロンの生成されたアーティファクトは、BoxコアSDKのバージョン10で導入されました。これは、現在、個別のブランチとして提供されています。
Boxでは、Boxの次世代アーティファクトからBoxコアSDKのv10.0.0への移行を支援するために、詳細な移行ガイド (英語) を用意しました。
プロジェクトに必要な対応
どのバージョンを使用すべきかわからない場合は、以下の場合に推奨される操作を確認してください。
- BoxコアSDKのみを利用している既存のアプリケーションがあり、プロジェクトをさらに開発する場合は、統合されたパッケージを含むメジャーバージョンを使用します。生成されたパッケージから便利なメソッドや新機能の使用を開始し、段階的にコードベースを移行します。最終的には、BoxコアSDKパッケージ (v10.0.0以上) に移行します。
- Boxの次世代SDKを利用している既存のアプリケーションがあり、プロジェクトをさらに開発する場合は、パッケージマネージャ内のライブラリ名をBoxコアSDKパッケージ (v10.0.0以上) に置き換えます。詳細な手順については、移行ガイドを確認してください。
- BoxコアSDKとBoxの次世代SDKの両方を利用している既存のアプリケーションがあり、プロジェクトをさらに開発する場合は、統合されたパッケージを含むメジャーバージョンを使用します。
- 新規アプリケーションを作成する場合は、BoxコアSDKのv10.0.0以上を使用します。
- 変更する予定のない既存のアプリケーションがある場合は、パッケージマネージャにSDKの特定のバージョンを含めることで、誤って更新されないようにします。Boxでは、統合されたパッケージを含むメジャーバージョンにアップグレードして、継続しているセキュリティパッチや改善を受け取れるようにすることを強くお勧めします。
サポートの窓口
質問や問題は、GitHubの個々のBox SDKリポジトリで直接報告することをお勧めします。また、BoxコミュニティフォーラムのSDKs and Toolsスレッド (英語のみ) で質問を投稿することもできます。