プロジェクト設定でデータベース接続の詳細を設定できます。設定後、プリ／ポストプロセッサのステップにデータベース操作を追加することで、エンドポイントのデバッグおよびテスト中にこれらの接続を使用できます。これにより、データベースからの読み取りやデータベースへの書き込みをシームレスに行えます。Apidog の無料版では、次のデータベースへの接続がサポートされています。SQL Server: SQL Server 2014 以降のバージョンをサポートします
ClickHouse（Basic プランが必要です）
データベース接続の設定#
Apidog でデータベース接続を設定するには、次の手順に従ってください。1.
Project Settings → Database Connections を開きます。
2.
右上隅の + New をクリックして、データベース接続を作成します。
3.
利用可能なオプションからデータベースの種類を選択し、ホスト、ポート、データベース名、ユーザー名、パスワードなど、必要な接続情報を入力します。入力には 変数 を使用することを推奨します。すべて変数で入力されたデータベース接続は、コラボレーションのためにクラウドに保存できます。
4.
ユーザー名とパスワードを使用するローカル接続方法に加えて、データ送信をより適切に保護するため、SSH トンネル経由でより安全な接続を確立することもできます。
5.
Save をクリックすると、この接続をプリ／ポストプロセッサで使用できます。
データベース接続の使用#
エンドポイントリクエストのプリ／ポストプロセッサに「Database Operations」を追加して、データベース接続を参照できます。追加後、「Database Operations」でデータベース接続を指定できます。1.
Run タブ（Design Mode）または Request タブ（Request Mode）で、プリ／ポストプロセッサに移動します。
2.
Add PreProcessor または Add PostProcessor にカーソルを合わせ、Database Operation を選択します。
3.
データベース操 作に名前を付け、データベース接続を設定します。選択した「Database Connection」が正しく設定されていることを確認してください。詳細はこちら。 4.
SQL コマンドを入力します。コマンドでは {{variables}} などの変数がサポートされています。
5.
必要に応じて Extract Result To Variable（JSONPath をサポート）を有効にし、Console Log を切り替えます。
6.
Send をクリックしてエンドポイントリクエストを実行し、コンソールで結果を確認します。
Apidog は標準 SQL クエリをサポートしていますが、ストアドプロシージャなどの複雑な SQL 操作はサポートしていません。
重要な注意事項#
リクエスト経由でデータベース操作を実行する前に、設定されたデータベース接続が適切に保存されていることを確認してください。データベース接続で変数を使用し、クラウドに保存している場合は、関連する変数の Current Value フィールドに実際のデータベース詳細（ホスト、ユーザー名、パスワードなど）を設定してください。または、変数設定メソッドを使用して、これらの値を動的に設定できます。
データベース接続で固定テキストを使用し、ローカルに保存している場合は、Project Settings → Database Connection で実際のデータベース詳細（ホスト、ユーザー名、パスワードなど）を入力する必要があります。
ストレージの仕組みとデータセキュリティ#
現在、Apidog ではデータベース接続を保存する方法が 2 つ用意されています。Apidog Cloud に保存: データベース接続がすべて変数を使用して設定されている場合、Apidog のクラウドサーバー上に変数として保存されます。
ローカルに保存: データベース接続が固定テキストを使用して設定されている場合、ローカル設定ファイルにプレーンテキストとして保存されます。
ストレージの仕組みの違い#
| ストレージの仕組み | 保存方法 | 利点 | 欠点 |
|---|
| クラウド | 設定で変数を使用 | 1. チームメンバーとのより便利なコラボレーションが可能になります。
2. CI、Runner などを経由してテストシナリオを実行する場合、ローカルファイルを管理する代わりに、変数を使用して データベース接続の詳細を設定できます。 | ⚠️ 変数の初期値にプレーンテキストを使用すると、データベース名やパスワードなどのデータがプレーンテキストで Apidog のクラウドサーバーに送信され、データセキュリティ上のリスクが生じます（変数に現在値を使用すると、データはローカルに保存されるため、このリスクはなくなります）。データセキュリティリスクを回避するため、vault variablesを使用することを推奨します。 |
| ローカル | 設定で固定テキストを使用 | ローカルに保存されるため、セキュリティリスクはありません | 1. コラボレーションに適しておらず、各チームメンバーがデータベース接続を個別に設定する必要があります。
2. CI、Runner、または同様のツールを通じてテストシナリオを実行する場合、データベース接続用の専用ローカルファイルを管理する必要があります。 |
優れたユーザー体験とデータセキュリティのバランスを取るため、Apidog はデータベース接続をクラウドに保存し、Vault 変数を使用してデータの安全性を確保することを推奨します。データベース接続に関連する変数の初期値にプレーンテキストを使用することは、重大なデータセキュリティリスクにつながる可能性があるため、強く推奨されません。
