API versioning strategy
API versioning strategy
Boxでは、特定のAPIエンドポイントに対してバージョン管理機能を提供しています。このバージョン管理システムにより、Boxがエンドポイントのバージョンを新しく導入した場合でも、既存のエンドポイントのバージョンに対してシームレスな機能が保証されます。
APIのバージョン管理により、Boxは、自社のプラットフォームを継続的に強化できると同時に、機能の更新や廃止のための信頼できる手段をサードパーティの開発者に提供することもできます。
Box APIのバージョン管理の仕組み
Versioning in path
The default version of the API used in any requests is specified in the URL of the endpoint you call. For example, when calling the https://upload.box.com/api/2.0/files/content
endpoint without any version header specified, you reach the 2.0
version defined in the URL.
APIの動作に大きな変更があると、新しいエンドポイントは新しいURLで公開されます。たとえば、https://upload.box.com/api/2.0/files/content
では、Boxにファイルをアップロードする際にマルチパートのコンテンツタイプをサポートしています。このAPIの 新しいバージョンでこのコンテンツタイプがサポートされなくなると、新しいバージョンは新しいURLhttps://upload.box.com/api/3.0/files/content
でリリースされます。
Versioning in header
Box API processes the box-version
header which should contain a valid version name, that is box-version: 2025.0
and be directed at https://api.box.com/2.0/files/:file_id/metadata
.
指定したバージョンが正しい場合は、クライアントにレスポンスが返されます。リクエストでbox-version
ヘッダーを指定した場合、レスポンスにはこのヘッダーも含まれます。デフォルトでは、このヘッダーはレスポンスに存在しません。バージョンが正しくない場合は、HTTPコード400
のエラーがクライアントに返されます。
リリーススケジュールと命名規則
Box can introduce a new breaking change to certain endpoints once per year. Introducing a new version of the Sign Request endpoint means that all paths and HTTP methods of an endpoint will support it.
For example, if Sign Request endpoints receive a new version it will apply to all endpoints listed in the table:
メソッド | リクエストURL | 説明 |
---|---|---|
GET | https://api.box.com/2.0/sign_requests/:id | 特定の署名リクエストの詳細を取得します。 |
GET | https://api.box.com/2.0/sign_requests/ |