Forge Viewer のバージョン指定

Forge が提供する各種 API は、クラウドサービスと同様に、定期的に更新されています。ただし、Authentication API や Model Derivative API、Data Management API など、RESTful API でクラウドとコミュニケーションをするようなタイプの API は、互換性を崩すような大きな変更や更新が頻繁にあるわけではありません。むしろ、既存アプリの互換性を維持するために、endpoint などを変更してしまうことは稀と言えます。

実際のところ、2016年6月の正式リリース以降、それらの API には互換性を崩すような変更は加えられていません。もし、今後、大きな変更がある場合でも、変更前の endpoint はそのまま維持して、新バージョン用の endpoint を追加するなど、新旧バージョンが安全に稼動する状況を維持するはずです。

このような考え方は、正式には "API" と呼んでいない Forge Viewer にも当てはまります。Viewer が "API" と呼ばれない理由については、過去のブログ記事 Forge 用語について をご参照ください。重要なのは、最も頻繁に更新され、既存アプリに互換性の問題が生じがちなのが、エンドユーザのフロントインタフェースとなる Viewer が提供する JavaScript ライブラリであるという点です。Viewer JavaScript ライブラリの更新履歴は、デベロッパポータルの Viewer ページにある Recent Changes（最近の変更）リンクから参照することが出来ます。

Recent Changes では、現在の Viewer 最新バージョンは 2.11 になっていますが、ある理由から、実際に配信されているのは 2.10 というバージョンです。使用する Forge Viewer JavaScript ライブラリのバージョンは、Forge Viewer の表示領域（div タグセクション）を持つ HTML ファイル内で指定することができます。具体的には、Forge Viewer の JavaScript ライブラリと付随する Cascating Style Sheet（CSS）参照でバージョンを指定することが可能です。もし、この部分でバージョン指定をおこなわないと、常に最新バージョンが参照されることになります。2016年1月現在では、2.10 バージョンです。

<html>
<head>
 <title>ADN Viewer Demo</title>
 <link rel="shortcut icon" href="/images/favicon.ico" type="image/x-icon" />
 <link type="text/css" rel="stylesheet" href="https://developer.api.autodesk.com/viewingservice/v1/viewers/style.css"/>
 <script src="https://developer.api.autodesk.com/viewingservice/v1/viewers/viewer3D.min.js"></script>
</head>

<body style="margin:0">
 <div id="viewerDiv"></div>
</body>
</html>

上記の場合、バージョン 2.10 が使用されます。分かりやすく設定画面を表示させると、2.10 が持つ設定パネルを表示します。

一方、明示的なバージョンを ?v=v の後に指定することも出来ます。例えば、2.7.44 バージョンを指定する場合には、次のように記入します。

<html>
<head>
 <title>ADN Viewer Demo</title>
 <link rel="shortcut icon" href="/images/favicon.ico" type="image/x-icon" />
 <link type="text/css" rel="stylesheet" href="https://developer.api.autodesk.com/viewingservice/v1/viewers/style.css?v=v2.7.44"/>
 <script src="https://developer.api.autodesk.com/viewingservice/v1/viewers/viewer3D.min.js?v=v2.7.44"></script>
</head>

<body style="margin:0">
 <div id="viewerDiv"></div>
</body>
</html>

この内容で Forge Viewer を表示させると、バージョン 2.7.44 の JavaScript ライブラリと CSS を使用した Viewer に指定したコンテンツを表示することが出来ます。こちらの場合も、分かりやすく設定画面を表示させると、2.7.44 が持つ設定パネルを表示します。

バージョン指定をおこなう場合は、細かい末尾の指定はアスタリスク * でカバーさせることも可能です。前述の 2.7. 44 の部分を 2.7.* とすると、2.7.44 ではなく、2.7 バージョンシリーズ上の最新のリビジョンを参照することになります。

このように、Forge Viewer を利用する場合には、動作を確認したバージョンを指定して動作させることが出来ます。この方法を利用することで、ある日、関数仕様の変更などで互換性を崩す新バージョンの Forge Viewer JavaScript ライブラリがリリースされた場合でも、動作を継続させることが出来るようになります。

By Toshiaki Isezaki