プロジェクト設定でデータベース接続の詳細を設定できます。一度設定すると、前/後処理ステップにデータベース操作を追加することで、APIのデバッグやテスト中にこれらの接続を利用できます。これにより、データベースからの読み取りや書き込みをシームレスに行うことができます。Apidogの無料版では、以下のデータベースへの接続がサポートされています:SQL Server: SQL Server 2014以降のバージョンをサポート
データベース接続の設定#
Apidogでデータベース接続を設定する手順は以下の通りです:1
プロジェクト設定
->
データベース接続
を開きます。
2
右上の+ 新規
をクリックしてデータベース接続を作成します。
3
利用可能なオプションからデータベースの種類を選択し、ホスト、ポート、データベース名、ユーザー名、パスワードなどの必要な接続情報を入力します。
変数を使用して入力することをお勧めします。変数で完全に入力されたデータベース接続は、クラウドに保存してコラボレーションすることができます。
4
ユーザー名とパスワードを使用したローカル接続方法に加えて、SSHトンネルを介してより安全な接続を確立し、データ伝送をより良く保護することもできます。
5
保存
をクリックすると、この接続は前/後処理で使用できます。
データベース接続の使用#
APIリクエストの前/後処理に「データベース操作」を追加して、データベース接続を参照できます。追加後、「データベース操作」でデータベース接続を指定できます。1
実行
タブ(設計モード)またはRequest
タブ(デバッグモード)で前/後処理に移動します。
2
前処理を追加
または
後処理を追加
にカーソルを合わせて
データベース操作
を選択します。
3
データベース操作に名前を付け、データベース接続を設定します。選択した「データベース接続」が正しく設定されていることを確認してください。
詳細はこちら4
SQLコマンドを入力します。コマンド内で{{variables}}
のような変数がサポートされています。
5
Extract Result To Variable
(JSONPathをサポート)を有効にし、必要に応じてConsole Log
を切り替えます。
6
送信
をクリックしてAPIリクエストを実行し、コンソールで結果を確認します。
自動テストでデータベース操作
を使用する場合、テストステップとして、またはAPIリクエストの前/後処理で使用する場合も、上記の手順に従って設定および使用できます。Apidogは標準的なSQLクエリをサポートしていますが、ストアドプロシージャのような複雑なSQL操作はサポートしていません。
重要な注意事項#
リクエストを介してデータベース操作を実行する前に、設定されたデータベース接続が適切に保存されていることを確認してください:データベース接続が変数を使用してクラウドに保存されている場合、関連する変数の現在の値
フィールドに実際のデータベースの詳細(ホスト、ユーザー名、パスワードなど)を設定してください。あるいは、変数設定方法を使用してこれらの値を動的に設定することもできます。
データベース接続が固定テキストを使用してローカルに保存されている場合、プロジェクト設定
-> データベース接続
で実際のデータベースの詳細(ホスト、ユーザー名、パスワードなど)を入力する必要があります。
ストレージメカニズムとデータセキュリティ#
現在、Apidogはデータベース接続を保存するために2つの方法を提供しています:Apidogクラウ ドに保存:データベース接続が完全に変数を使用して設定されている場合、Apidogのクラウドサーバー上の変数として保存されます。
ローカルに保存:データベース接続が固定テキストを使用して設定されている場合、ローカルの設定ファイルにプレーンテキストとして保存されます。
ストレージメカニズムの違い#
ストレージメカニズム | 保存方法 | 利点 | 欠点 |
---|
クラウド | 設定に変数を使用 | 1. チームメンバーとのコラボレーションがより便利になります。 2. CI、ランナーなどを介してテストシナリオを実行する際、ローカルファイルを維持する代わりに変数を使用してデータベース接続の詳細を設定できます。 | ⚠️ 変数の初期値にプレーンテキストを使用すると、データベース名やパスワードなどのデータがプレーンテキストでApidogのクラウドサーバーに送信され、データセキュリティリスクを引き起こします(変数の現在の値を使用すると、データはローカルに保存され、このリスクはなくなります)。データセキュリティリスクを回避するために、Vault変数を使用することをお勧めします。 |
ローカル | 設定に固定テキストを使用 | ローカルに保存され、セキュリティリスクがありません | 1. コラボレーションが難しい;各チームメンバーが個別にデータベース接続を設定する必要があります。 2. CI、ランナーなどを介してテストシナリオを実行する際、データベース接続用の専用ローカルファイルを維持する必要があります。 |
優れたユーザーエクスペリエンスとデータセキュリティのバランスを取るために、Apidogはデータベース接続をクラウドに保存し、Vault変数を使用してデータの安全性を確保することを推奨しています。データベース接続に関連する変数の初期値にプレーンテキストを使用することは、重大なデータセキュリティリスクを引き起こす可能性があるため、強く推奨されません。