IBM API Connect のデベロッパーズ・ツールキットをインストール・バージョンアップする方法




IBM API Connect についての概要は[こちらの記事「IBM API Connectで既存のAPIを公開してみる - IBM API Connectとは」](http://qiita.com/Naomi_Tanaka/items/b20047d60db2143d9f6b#ibm-api-connect%E3%81%A8%E3%81%AF)をご参照ください。

## デベロッパーズ・ツールキットとは
デベロッパーズ・ツールキットとは、IBM API Connectの製品コンポーネントの1つであり、APIの開発やテストを行うためのAPI開発者向けのツールです。


具体的には、以下のツールとランタイムが提供される。

+ API Connectのコマンド・ライン・ツール、
+ APIの開発、ポリシー定義やテストを行うためのAPIデザイナー(ブラウザーベースのツール)
+ 開発したAPIをテストするためのNode.jsベースのAPIのランタイムとMicro Gateway

API ConnectのBluemix版でもオンプレ版でも同様に利用することが可能。

## デベロッパーズ・ツールキットのバージョンについて
API Connectのデベロッパーズ・ツールキットのバージョンは、API Connectの管理サーバーや他のコンポーネントと合わせておく必要がある。また、API Connectのリリースアップにより前提とするNode.jsのバージョンも上がることがあるので、システム前提を確認するようにしておく。
デベロッパーズ・ツールキットのバージョンアップの方法についても後述する。

## デベロッパーズ・ツールキットの前提条件の確認
IBM API Connectの2017年5月9日時点の最新はV5.0.7となっており、システム前提条件は[こちら](https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=B4F79D30657E11E6865BC3F213DB63F7)から確認できる。
デベロッパーズ・ツールキットのシステム前提を抜粋しておく。

#### サポートされるOS
+ Red Hat Enterprise Linux (RHEL) Server 7(x86-64)
+ SUSE Linux Enterprise Server (SLES) 12(x86-64)
+ Ubuntu 14.04 LTS
+ OS X Yosemite 10.10
+ Windows 7 Professional/Enterprise
+ Windows 8 Professional/Enterprise
+ Windows 8.1 Professional/Enterprise
+ Windows 10 Pro/Enterprise

#### サポートされるNode.js
+ IBM SDK for Node.js V4.4.0.0 and future fix packs
+ IBM SDK for Node.js V4.4.3.0 and future fix packs
+ IBM SDK for Node.js V4.4.4.0 and future fix packs
+ IBM SDK for Node.js V4.4.5.0 and future fix packs
+ IBM SDK for Node.js V4.4.6.0 and future fix packs
+ IBM SDK for Node.js V4.4.7.0 and future fix packs
+ IBM SDK for Node.js V6.0.0.0 and future fix packs
+ Node.js v4.4.0 and future fix packs
+ Node.js v6.0.0 and future fix packs

API Connect v5.0.7では、IBM SDK for Node.js v6が推奨とある。
IBM SDK for Node.js、Node.jsいずれも、5.xとv7.xはサポートされない。

#### ハードウェア
+ Disk容量 OS以外に最低2GB
+ メモリ8GB推奨
+ 2コアCPU推奨

今回は、Mac OSにインストールする。



## Node.jsのインストール

デベロッパーズ・ツールキットはNode.jsが前提となるので、事前に導入する。すでに導入されている場合には、導入されているバージョンを確認して、前提を満たしていない場合は導入を行う。

今回はNode.jsの管理にnodebrewを利用する。
nodebrewをインストール。

```
$ curl -L git.io/nodebrew | perl - setup
```

.bash_profileにPATHを追加。


```
$ vi ~/.bash_profile
```

```.bash_profile
export PATH=$HOME/.nodebrew/current/bin:$PATH
```

.bash_profileを読み込み。

```
$ source ~/.bash_profile
```

Node.js v6.0.0をnodebrew経由でインストールする。


```
$ nodebrew install-binary v6.0.0
Fetching: https://nodejs.org/dist/v6.0.0/node-v6.0.0-darwin-x64.tar.gz
######################################################################## 100.0%
Installed successfully
```
nodebrewでv6.0.0を指定する。

```
$ nodebrew ls
v6.0.0

current: none
$ nodebrew use v6.0.0
use v6.0.0
```

nodeとnpmのバージョンを確認する。

```
$ node -v
v6.0.0
$ npm -v
3.8.6
```

[マニュアル](https://www.ibm.com/support/knowledgecenter/ja/SSMNED_5.0.0/com.ibm.apic.toolkit.doc/tapim_cli_install.html)にnpmのバージョンは、v3.x.xと書いてあるので、v3.x.xでない場合は、`npm install -g npm`で更新する。

## デベロッパーズ・ツールキットのインストール

デベロッパーズ・ツールキットをnpmからインストールする。
プロキシー・サーバーの指定方法は[マニュアル](https://www.ibm.com/support/knowledgecenter/ja/SSMNED_5.0.0/com.ibm.apic.toolkit.doc/tapim_cli_install.html)を参照。

```
$ npm install -g apiconnect
```

インターネットに接続できない環境の場合は、API Connectの管理サーバーからも導入することができる。詳細は[マニュアル](https://www.ibm.com/support/knowledgecenter/ja/SSMNED_5.0.0/com.ibm.apic.toolkit.doc/tapim_cli_install.html)を参照。

インストールが終わったら、導入されたバージョンを確認する。

```
$ apic -v
API Connect: v5.0.7.0 (apiconnect: v2.6.2)
```

ライセンスの同意を求められた場合には、「はい」を選択する。

```
? /Users/naomit/LICENSE.txt にある API Connect のライセンスを 確認し、条件に同意する場合は「はい」を選択してください。 (Use arrow keys)
❯ はい 
  いいえ
```

Live Helpの機能を有効にするかどうかを聞かれた場合には、「no」「yes」のどちらかを選択する。

```
? Help us help you!  By providing the API Connect customer excellence team with
limited usage information about your product experience, we can pro-actively
provide assistance to enable your success while continuing to enhance the
product based on your feedback.  If you don't like it, you can always disable
it from My Account > Live Help
 (Use arrow keys)
❯ no 
  yes 
```



## デベロッパーズ・ツールキットのバージョンアップ

デベロッパーズ・ツールキットのバージョンアップは、一度アンインストールしてから再度導入する手順になる。

事前に以下のコマンドローカルのアプリケーションを停止する。

```
$ apic stop --all
```


npmでデベロッパーズ・ツールキットをアンインストールする。

```
# ツールキットの構成情報を削除する場合
$ npm rm -g apiconnect
# ツールキットの構成情報を保持する場合
$ npm rm apiconnect -g --no-config-clear
# ツールキットの構成情報を削除して、npmキャッシュをクリアする場合
$ npm rm apiconnect -g --cache-clear
# ツールキットの構成情報を保持して、npmキャッシュをクリアする場合
$ npm rm apiconnect -g --no-config-clear --cache-clear
```

Windows の場合は、C:¥Users¥username¥AppData¥Local¥Temp 内で、名前が npm- で始まるすべてのファイルを削除する。


再度インストールする。

```
$ npm install -g apiconnect
```