Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Home
Learning Center
Support Center
API References
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
APIテスト
Copy Page
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/Swagger仕様拡張
JSONPath
XPath
正規表現
JSONスキーマ
CSVファイルフォーマット
Java環境のインストール
ランナーのデプロイ環境
ApidogフレーバーMarkdown
APIテスト
Copy Page
パフォーマンステスト
パフォーマンステスト機能は現在ベータ版です。問題が発生した場合は、
テクニカルサポートDiscord
に参加してフィードバックを提供してください。
パフォーマンステストは、APIに大規模なサービスリクエストを送信し、パフォーマンスのボトルネックを特定し、安定性を評価し、負荷下での潜在的なリスクを明らかにし、APIが高負荷下でも確実に動作し、リクエストに応答できることを確認することを目的としています。
設定項目の指定
#
パフォーマンステストを実行する前に、テストシナリオの実行環境とオプションでテストデータを指定し、パフォーマンステストの設定を構成する必要があります。
実行環境
#
テストシナリオの実行環境は、現在のプロジェクトの環境から継承されます。
テストデータ
#
テストデータを関連付けた後、仮想ユーザーはテストデータで定義された変数を使用してリクエストを実行します。「ランダムマッチ」または「順次マッチ」モードで実行するかを選択できます:
ランダムマッチ:
各仮想ユーザーはテストデータからランダムに1行のデータを選択して実行します。このモードでは、すべての仮想ユーザーが1つのテストデータ行を選択し、パフォーマンステストを実行します。
順次マッチ:
各仮想ユーザーはテストデータから順番に1行のデータを選択します。注意:仮想ユーザーの数がテストデータの行数を超える場合、超過した仮想ユーザーはパフォーマンステストを開始しません。
テストデータの詳細についてはこちら
。
仮想ユーザー(同時ユーザー)
#
最大100人の仮想ユーザーをサポートします。指定されたテスト時間内に、オンラインユーザーがテストシナリオを並列で繰り返し実行することをシミュレートします。
テスト期間
#
パフォーマンステストの総実行時間です。この期間中、各仮想ユーザーはテストシナリオ内のすべてのAPIを連続してループします。
ランプアップ時間
#
ユーザーは通常、サービスに徐々にアクセスします。これをシミュレートするために、最初のX分間(Xは事前設定値)で並列ユーザー数を徐々に増やすランプアップ時間を設定します。Xを0に設定すると、すべての仮想ユーザーがテスト開始時に即座に開始します。
パフォーマンステストの実行
#
パフォーマンステストをトリガーすると、直感的なビジュアルパネルが表示され、各APIの
総リクエスト数、平均スループット、平均応答時間、最大/最小応答時間、エラー
などの主要なメトリクスが表示されます。
プロジェクトごとに一度に1つのパフォーマンステストしか実行できません。より優先度の高いテストを実施する必要がある場合は、右上の「終了」ボタンをクリックしてください。
テストプロセスの確認
#
パフォーマンステスト中、テストチャートにカ ーソルを合わせると、各期間のテスト詳細をリアルタイムで確認できます。
「エラー」をクリックすると、APIの失敗したリクエストを確認し、原因を分析できます。フィルターバーでAPIリクエストをフィルタリングすることもできます。
パフォーマンステストではAPIリクエストの量が多いため、失敗したリクエストのみがカテゴリ別に統計的に表示されます。各APIの詳細なエラー情報とリクエストの詳細は記録されません。予期しないエラーが発生した場合は、まず「機能テスト」を実行し、すべての問題を解決してから「パフォーマンステスト」を実行してください。
テストレポートの確認
#
「
テストレポート
」タブをクリックすると、現在のテストシナリオの過去のテストレポートを確認できます。
FAQ
#
Q: パフォーマンステストレポートをエクスポートするにはどうすればよいですか?
A: パフォーマンステストは現在ベータ段階であり、Apidogはまだパフォーマンステストレポートのエクスポートをサポートしていません。Apidogクライアント内でのみ結果を確認できます。
Q: パフォーマンステストで実際のリクエストとレスポンスを確認するにはどうすればよいですか?
A: Apidogのパフォーマンステストでは、実際のリクエストとレスポンスを確認する機能は提供されていません。
これは、パフォーマンステストが高負荷下でのAPIの動作を評価することに焦点を当てており、これらのAPIはすでに100%機能テストを通過しているはずだからです。問題が発生した場合、その原因はサーバーのパフォーマンスによるものであり、リクエスト/レスポンスの内容によるものではありません。
したがって、実際のリクエストとレスポンスを確認しても、パフォーマンス関連の問題のトラブルシューティングには役立ちません。そのため、Apidogのパフォーマンステスト機能では、実際のリクエストとレスポンスを確認する機能は提供されていません。
Previous
エンドツーエンド(E2E)テスト
Next
概要