api
apiconnect

API Connectのデベロッパー・ツールキットの最適なバージョンを判断する方法

はじめに

API Connectのローカルにインストール可能なデベロッパー・ツールキットは、npmコマンドにて以下のように簡単にインストール可能です。

npm install -g apiconnect

デベロッパー・ツールキットのインストールそのものについては、こちらの記事に詳しく書かれています。
ここでは、デプロイする先のAPI Connectのサーバー側の環境に最も適したToolkitをインストールするという点に絞って説明します。Knowledge Centerには以下のように書かれています。

For best results, install the version of the toolkit that corresponds to the version of your API Connect Management Server.

ですので、バージョンは同じものに合わせた方が望ましいですね。ちなみに先のコマンドでは、その時点の最新のツールキットがインストールされます。常に最新の環境が準備されているプロジェクトでは、それでも問題は無いのかも知れませんが、実際には、特定のバージョンで固定しているのが普通かと思います。

API Connectのバージョンを知る

作成したAPI製品をデプロイする先のAPI Connectのバージョンを確認します。
API ManagerにCLIでログインし、system show versionコマンドで確認可能です。

pict01.PNG

対象のAPI Connectのバージョンは、5.0.8.1であることが判ります。

最適なToolkitのバージョンを調べる

対象となるAPI Connectに対応する最適なToolkitのバージョンは、npm dist-tag ls apiconnect コマンドで確認ができます。

pict02.PNG

ちなみにこのdist-tagコマンドは、Packageのdistribution tagを操作するコマンドでlsオプションは、すべてのdist-tagを表示するという意味です。

特定バージョンのToolkitをインストールする

今回、対象となるAPI Connectのバージョンは、5.0.8.1ですので対応するToolkitのバージョンは、2.7.62ということがわかりました。バージョンを指定してインストールするには、パッケージ名の後ろに@でバージョン番号を続けます。

npm install -g apiconnect@2.7.62

これで指定したバージョンのToolkitがインストールされます。

最適なToolkitを導入するもう一つの方法

API Connectの管理サーバーにアクセス可能であれば、そこからToolkitを導入することも可能です。この場合は当然、バージョンは、管理サーバーと同じということになります。コマンドは、以下の通りです。

npm install -g --unsafe-perm https://管理サーバーのホスト名/packages/apiconnect

環境によってはコマンドを叩いてから少し待ちがあったりしますが、しばらくするとインストールは完了します。

もし証明書関連のエラーが出たら

自己証明書を使っている環境では、証明書関連のエラーが出ることがあります。
その場合は、以下のコマンドを発行すると回避することができます。このコマンドを発行するには、管理者権限が必要です。

npm config -g set strict-ssl false

念のための確認

apicコマンドを発行してインストールされたToolkitのバージョンを確認します。初回の実行では、ライセンス関係の確認が表示されます。以下の例は、2回目以降のものです。

pict03.PNG

確かに2.7.62のToolkitがインストールされていることが判ります。