MongoDBからWebAPIをポイント＆クリックで作成

MongoDBからWebAPIをポイント＆クリックで作成
CData Software ハンズオン（MongoDBからWebAPIをポイント＆クリックで作成）
# 使用するCData製品

- [CData API Server](http://www.cdata.com/jp/apiserver/)

# MongoDB環境構成

あらかじめ以下の手順に従って、MongoDBアカウントを取得しておきます。

[mLab を使ったMongoDB環境の構築方法とサンプルデータのインポート方法](https://qiita.com/sugimomoto/items/81d654a2d4f0018cba0f)

# CData API Serverのインストール

以下のサイトからCData API Serverのビルドをダウンロードします。

- [CData API Server](https://s3-ap-northeast-1.amazonaws.com/cdatajbuilds/HandsOn/20180517/CDataAPIServer.exe)

ダウンロードされた「setup.exe」ファイルを起動します。下記のようなインストーラが起動するので、ライセンス契約書を確認した上で、デフォルト設定のままインストールを進めて完了させます。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/390c2826-eb41-3379-fa38-2f9f38bc5845.png)

途中、APIServerの管理者(admin)のパスワードを設定する画面が表示されるので、設定したパスワードは手元に控えておいてください。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/4e268000-3ba0-b471-68d9-a389f1e86335.png)


インストールが完了するとWindows右下の通知エリアに青い雲のアイコンのCData APIServerに組み込まれているWebサーバが起動します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/67b4bdcf-6ea4-717f-d064-d686910c4b46.png)

また、デフォルトブラウザが起動してCData APIServerの管理コンソールへのログイン画面が起動します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/de092928-28ca-de35-911a-7586673406b9.png)

# CData ADO.NET Provider for MongoDBのインストール

APIServerからMongoDBへの接続ライブラリである、CData ADO.NET Provider for MongoDBをインストールします。

一度、CDataAPIServerを停止します。Windows右下の通知エリアに青い雲のアイコンを右クリックして「Stop Server」を実行します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/0b4d693a-4bb4-4e39-0bb1-e8ef832c5966.png)


サーバーが停止したのを確認して、以下のサイトからCData ADO.NET Provider for MongoDBのビルドをダウンロードします。

- [CData ADO.NET Provider for MongoDB](https://s3-ap-northeast-1.amazonaws.com/cdatajbuilds/HandsOn/20180517/MongoDBADO.NETProvider.exe)

ダウンロードされた「setup.exe」ファイルを起動します。インストーラが起動するので、ライセンス契約書を確認した上で、デフォルト設定のままインストールを進めて完了させます。

インストールが完了したら、再度、Windows右下の通知エリアに青い雲のアイコンを右クリックして「Start Server」を実行します。Startしたら青い雲のアイコンをダブルクリックするとブラウザが起動してCData APIServerの管理コンソールへのログイン画面が表示されます。

# MongoDBへの接続設定

CData APIServerの管理コンソールへのログイン画面で、ユーザ名「admin」、インストーラで設定したパスワードを入力して「サインイン」します。サインイン出来ると「情報」ページが表示されます。ライセンスが認証されていない旨のメッセージが表示されるので、「30日間の評価版をアクティベーションする」ボタンをクリックして、表示されるダイアログに「名前：」「Eメール」と入力し、「Terms and Conditions」を確認したら「評価版をアクティベーションする」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/2b5de635-9828-ec77-215c-56b724a4a01e.png)

ブラウザのリフレッシュをして、プロダクトーに30日間の試用版（30 DAY TRIAL VERSION - 30 DAYS LEFT）が表示されることを確認します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/9eba4b5f-c0ff-b408-2380-d3657cdf991d.png)

「設定 > 接続」タブを開き、「+Add Connection...」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/35b7ff37-3de2-84e9-cdc6-a53125ed9ea0.png)

Databases内の「MongoDB」を選択します。


![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/8d9f9574-ca6c-eff2-188d-c723beec6712.png)


MongoDBへの接続情報を設定します。設定後「Test Connection」ボタンをクリックして「The connection was successful.」が表示されればCDataAPIServerからMongoDBへ接続出来たことになります。接続情報を「Save Changes」ボタンで保存します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/d85598c1-804a-383e-6f2f-812bdfa0d625.png)


| 設定項目 | 設定値 |
|:-----------------|:------------------|
| Name | 任意（例では「MongoDB」と設定） |
| Provider Class | 変更不可（「System.Data.CData.MongoDB」と設定） |
| フォーマット設定 | デフォルト値 「Property List」 |
| Server | MongoDBのURL |
| Port | MongoDBDBへHTTPアクセスする際の対象Portアドレス |
| Database | MongoDBの接続対象DB  |
| User | MongoDBへのログインID |
| Password | MongoDBへのログインパスワード |

接続情報が保存されてConnectionsにMongoDBへの接続情報が表示されることを確認します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/c010fdfb-9255-0161-157c-34d31f30c781.png)


# APIエンドポイントの作成

「設定 > リソース」タブを開き、「リソースを追加...」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/1b6c4672-9373-693d-c302-545d4452f682.png)

先の手順で作成したMongoDBへのデータ接続設定を選択して「次へ」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/6f7004f9-db09-b103-930d-61c3b79f2759.png)

MongoDB内のテーブルおよびビューが一覧として表示されます。今回は[Sample]テーブルを選択して「次」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/6c65942b-abe4-a39c-13d9-cb980b7ed4b5.png)


[Sample]テーブル内の項目一覧が表示されます。デフォルトでは、「操作：」に全てチェックが付与されており、GET（SELECT）、POST（INSERT）、PUT（UPDATE）、DELETE（DELETE）と全てのCRUD操作を許可しています。また、アクセスユーザも「*(全ユーザ)」と設定してます。今回は、このまま「保存」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/70fa3453-b49f-1c91-f994-6492d7977b29.png)



リソース一覧画面に戻り、「CData_(DB名)_Sample」リソースが追加されたことを確認します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/ef0669aa-142a-5385-5ce3-3ebbfb954985.png)

# APIアクセスユーザの作成

「設定 > ユーザー」タブに移動して、ユーザの「追加」ボタンをクリックします。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/4ef2302b-7f31-b2b1-ce52-1719ccd6d37d.png)

「ユーザーを追加」ダイアログが表示されます。ユーザー名を入力（任意）して、ユーザ毎の操作権限「GET（SELECT）、POST（INSERT）、PUT（UPDATE）、DELETE（DELETE）」全てにチェックを入れて「変更を保存」ボタンをクリックします。本画面で、一定時間内のAPIアクセス数制限（RateLimit）および同時接続数の制限を付与することも出来ます。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/4dafd8af-793f-939f-6cae-80ab69206f8d.png)

ユーザ一覧画面に戻り、ユーザが追加されてAuthトークンが生成されたことを確認します。ユーザ名と本AuthトークンはAPIアクセス時に必要となりますの手元に控えておいてください。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/d489d4b9-3e07-d675-8f07-bf18f372ef0e.png)

# WebAPIへのアクセス

それでは、作成したWebAPIにアクセスしてみましょう。「API」タブを開くと、APIリファレンスが開きます。
左側にリソースの一覧が表示されますので、上の手順で追加したリソース「/api.rsc/（DB名）_Sample」を選択します。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/7000943b-c67e-5bda-833d-3518de48b83d.png)


右側にHTTPメソッド、および、各種プロパティや追加フォーマットの情報が表示されます。GETメソッドは、Webブラウザからリクエストを発行することができるので、ブラウザの新しいタブ、もしくは、Windowを開いてURLに「 http://localhost:8387/api.rsc/CData_（DB名）_Sample/ 」を入力して開いてみます。ブラウザのレスポンスとして、JSON形式で、MongoDB内のSampleテーブル内のデータが表示されれば成功です。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/56301/c6ea292b-bbeb-3abe-2066-0259a55a113c.png)


管理コンソールと同一のWebブラウザからアクセスする場合は、ユーザ認証が必要ありませんが、新規ブラウザからだと認証が必要となります。ユーザ名に上記手順で作成したAPIアクセスユーザ名、パスワードにAuthトークンを入力してください。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/123181/9a0a6ec7-a221-e92b-9951-6e6e9faf2e7b.png)

MongoDBからWebAPIを作成して、Webブラウザからアクセスすることが出来ました。