ローコードアプリ開発プラットフォームOutSystems でMySQL 連携アプリを作成

杉本和也
リードエンジニア

CData API Server を使ってMySQL のデータの仮想OData API エンドポイントを作成して、OutSystems からMySQL のデータを使ったアプリを作成する方法。

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData API Server を経由して OutSystems からMySQL に連携するアプリを作成する方法を説明します。

CData API Server は、MySQL のデータのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにMySQL のデータへ連携することができます。さらに、CData API Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなMySQL OData サービスを作成していきましょう。

MySQL への接続

OutSystems からMySQL のデータを操作するには、まずMySQL への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「MySQL」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、MySQL への接続設定を行っていきましょう！
Server およびPort プロパティがMySQL への接続には必須です。IntegratedSecurity をFALSE に設定した場合、User、Password も必須になります。オプションで、Database を設定することもできます。Database は設定がない場合すべてのデータベースを使えるようになります。

パスワード方式によるSSH 接続

パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。
- User: MySQL のユーザ
- Password: MySQL のパスワード
- Database: MySQL の接続先データベース
- Server: MySQL のサーバー
- Port: MySQL のポート
- UserSSH: "true"
- SSHAuthMode: "Password"
- SSHPort: SSH のポート
- SSHServer: SSH サーバー
- SSHUser: SSH ユーザー
- SSHPassword: SSH パスワード
接続文字列形式では以下のようになります。
```
User=admin;Password=adminpassword;Database=test;Server=mysql-server;Port=3306;UseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;
```
公開鍵認証方式方式によるSSH 接続

公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。
- User: MySQL のユーザ
- Password: MySQL のパスワード
- Database: MySQL の接続先データベース
- Server: MySQL のサーバー
- Port: MySQL のポート
- UserSSH: "true"
- SSHAuthMode: "Public_Key"
- SSHClientCertType: キーストアの種類
- SSHPort: SSH のポート
- SSHServer: SSH サーバー
- SSHUser: SSH ユーザー
- SSHClientCert: 秘密鍵ファイルのパス
接続文字列形式では以下のようになります。
```
User=admin;Password=adminpassword;Database=test;Server=mysql-server;Port=3306;UseSSH=true;SSHAuthMode=Public_Key;SSHClientCertType=PUBLIC_KEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;
```
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Server およびPort プロパティがMySQL への接続には必須です。IntegratedSecurity をFALSE に設定した場合、User、Password も必須になります。オプションで、Database を設定することもできます。Database は設定がない場合すべてのデータベースを使えるようになります。

パスワード方式によるSSH 接続

パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

User: MySQL のユーザ
Password: MySQL のパスワード
Database: MySQL の接続先データベース
Server: MySQL のサーバー
Port: MySQL のポート
UserSSH: "true"
SSHAuthMode: "Password"
SSHPort: SSH のポート
SSHServer: SSH サーバー
SSHUser: SSH ユーザー
SSHPassword: SSH パスワード

接続文字列形式では以下のようになります。

User=admin;Password=adminpassword;Database=test;Server=mysql-server;Port=3306;UseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

公開鍵認証方式方式によるSSH 接続

公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

User: MySQL のユーザ
Password: MySQL のパスワード
Database: MySQL の接続先データベース
Server: MySQL のサーバー
Port: MySQL のポート
UserSSH: "true"
SSHAuthMode: "Public_Key"
SSHClientCertType: キーストアの種類
SSHPort: SSH のポート
SSHServer: SSH サーバー
SSHUser: SSH ユーザー
SSHClientCert: 秘密鍵ファイルのパス

接続文字列形式では以下のようになります。

User=admin;Password=adminpassword;Database=test;Server=mysql-server;Port=3306;UseSSH=true;SSHAuthMode=Public_Key;SSHClientCertType=PUBLIC_KEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;

API Server のユーザー設定

次に、API Server 経由でMySQL にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

MySQL 用のAPI エンドポイントの作成

ユーザーを作成したら、MySQL のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ（https://myserver/api.rst#oas）にある「Open API」のファイルを以下から保存しておきましょう。

OData のエンドポイントを取得

以上でMySQL への接続を設定してユーザーを作成し、API Server でMySQL データのAPI を追加しました。これで、OData 形式のMySQL データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。