Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. データベース操作
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオのエクスポート
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオの作成
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. データベース操作

Apidogでデータベース操作

前/後処理はデータベースの追加をサポートしている。データベースを選択して接続すると、データテーブルに対してCRUD操作などができる。これらの操作結果はコンソールに表示したり、変数として抽出したりできる。抽出した変数は、他のAPIのパラメータやアサーション、カスタムスクリプト、他のデータベースとのやり取りなど、様々な場面で使える。

使い方#

データベース操作の手順は以下の通り:
1
実行タブ(設計優先)またはリクエストタブ(リクエスト優先)で、後処理に移動する。
設計優先
リクエスト優先
image.png
2
「後処理を追加」にカーソルを合わせて、「データベース操作」を選択する。
3
データベース操作に名前を付けて、データベース接続を選択する。
4
SQLコマンドを入力する。コマンド内で{{variables}}を使うことができる。
例えば、次のように SQL を使用できます:
5
SELECT文の結果を変数として抽出することができる。「結果を変数として抽出」を設定する。JSONPathがサポートされている。
SELECT文の結果は配列として取得され、各行が配列の要素となる。
例えば、JSONPath $[0].uidを使うと、結果の最初の行の「uid」フィールドの値を抽出できる。
6
「送信」をクリックしてリクエストを実行する。コンソールでデータベース操作の結果を確認できる。
Apidogは標準的なSQLクエリをサポートしているけど、ストアドプロシージャなどの複雑なSQL操作には対応していない。

データベース接続#

Apidog無料版は以下のタイプのデータベースへの接続をサポートしている:
MySQL
SQLServer(SQL Server 2014以上のバージョンに対応)
Oracle
PostgreSQL
有料版にアップグレードすると、さらに以下のデータベースへの接続もサポートされる:
Clickhouse
MongoDB
Redis
ApidogでOracleデータベースに接続するには、Oracleクライアントを別途インストールする必要がある。
Apidogでデータベース接続を設定する手順:
1
設定 - データベース接続に移動する
image.png
2
右上の「新規」をクリックして、新しいデータベース接続エントリーを作成する。
3
利用可能なオプションからデータベースタイプを選択し、ホスト、ポート、データベース名、ユーザー名、パスワードなどの必要な接続情報を入力する。
4
ユーザー名とパスワードでローカルにデータベースに接続する以外に、データ送信をより安全に保護するためにSSHトンネルを通じて接続することもできる。
5
「保存」をクリックすると、このデータベース接続をポストプロセッサーで選択できるようになる。
Apidogはデータのセキュリティを重視している。データベースのアドレス、ポート、ユーザー名、パスワード、データベース名はクライアント側にローカルで保存され、クラウドには同期されない。同じチーム内でも、メンバー間でデータベース接続情報は同期されず、各メンバーが手動で設定する必要がある。
MySQLに関するヒント
現在、最新のmysqlモジュールはMySQL8のデフォルトの暗号化方式である caching_sha2_password を完全にサポートしていない。
mysql_native_password モードを指定する必要がある方法を使用して、MySQLアカウントのパスワードを変更する必要がある。他のツールを使ってMySQLに接続し、以下のSQLを実行して対応するアカウントのパスワードを変更してね。
上記のusernameとパスワードは手動で置き換えてね。

複数環境でのデータベース操作の使用#

テスト環境や本番環境など、複数の環境で作業する場合、それぞれ異なるデータベースが設定されていることが多い。ワークフローでデータベース操作を使用している場合、環境の切り替えに合わせてこれらの操作も切り替える必要がある。
このような場合、Apidogの「データベース接続」設定で複数のデータベース接続を設定できる。各環境用のデータベース接続を設定しておけば、右上のドロップダウンメニューで環境を切り替えると、データベースクエリは自動的にその環境に関連付けられたデータベース接続に振り分けられる。

NoSQLデータベースの使用#

MongoDBの操作については、MongoDB操作を参照してね。
Redisの操作については、Redis操作を参照してね。

Apidog CLIでのデータベース操作の使用#

Apidogは、コマンドラインインターフェース(CLI)を使用して、どのプラットフォームでもテストシナリオを実行できる。CLIを使用することで、サーバーからテストシナリオの設定をリアルタイムで取得して効率的に実行できる。
ただし、データベース操作はローカルに保存されるため、CLIからデータベース設定に動的にアクセスすることができない。
この場合、データベース操作を設定ファイルとしてエクスポートし、CLIを実行するマシンに配置する必要がある。詳しくはApidog CLIを参照してね。

FAQ#

Q: Apidogで複数のSQLクエリを1つのデータベース操作にまとめることはできる?
A: Apidogの各データベース操作では、1つのSQLクエリしか実行できない。複数のSQLクエリを実行する必要がある場合は、別々のデータベース操作に分けて実行する必要がある。
Modified at 2025-04-15 10:03:17
Previous
アサーション
Next
MongoDB
Built with