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
回帰テスト
アプリケーションの改善や更新を行う際、これらの変更が既存の機能に悪影響を及ぼさないことを確認することが重要です。回帰テストは、変更されたコンポーネントがアプリケーションの他の部分とシームレスに統合され、新しい不具合(いわゆる「回帰」)が発生しないことを保証するために一連のテストを実行するプロセスです。
APIの場合、回帰テストは、APIやその環境に対する変更が依存コンポーネントに悪影響を及ぼさないことを確認することを意味します。これらのテストは、バグ修正から機能追加までのあらゆる変更後に実行できます。回帰テストは通常、以下のようなAPI要素をカバーします:
1.
ステータスコード
- 異なるリクエストタイプに対して適切なステータスコードが返されることを確認します。
2.
JSONスキーマ
- レスポンスの構造とフォーマットがAPI仕様に準拠していることを確認します。
3.
レスポンス時間
- APIのレスポンス時間が許容範囲内に収まっていることを確認します。
4.
レスポンスボディ
- レスポンスの内容と構造が期待通りであることを確認します。
5.
ヘッダー
- レスポンスヘッダーの存在と正確性を検証します。
Apidog CLIなどの自動化ツールを使用して、コード更新をデプロイする前に回帰テストを実行することで、本番環境に重大な変更が及ぶのを防 ぐことができます。また、Collection Runnerを使用してテストをスケジュールし、時間経過に伴う結果を監視することで、APIの信頼性に関する洞察を得ることができます。
Apidogでの回帰テスト設定
#
Apidogでアプリケーションの統合テストを設定するには、以下のフレームワークを使用します:
1.
APIリクエスト
: テストの基本単位はAPIリクエストです。各リクエストは、APIエンドポイントを呼び出すことで特定の機能をテストします。詳細は
リクエストの送信
を参照してください。
2.
前/後処理
: 各リクエストに対して、スクリプト、アサーション、変数の抽出、データベース操作などを追加して、レスポンスコード、ヘッダー、ボディデータなどをテストおよび検証できます。詳細は
前/後処理の追加
を参照してください。
3.
テストシナリオ
: 複数のリクエストを連続して送信する必要がある場合、連続したテストシナリオを構築したり、異なるテストデータでリクエストを繰り返したりするために、テストシナリオを作成し、必要なリクエストを追加できます。詳細は
テストシナリオ
を参照してください。
4.
環境
: APIリクエストを行う際、開発、テスト、本番環境を切り替える必要があることがよくあります。Apidogでは、インターフェースの右上隅で希望の環境をクリックして選択す るだけで、異なる環境にリクエストを送信できます。詳細は
環境の作成と使用
を参照してください。
5.
Mockサーバー
: 他のシステムをMockサーバーでシミュレートします。実際のリソースに接続せずに、アプリケーションが他のAPIやシステムとどのように相互作用するかをテストできます。代わりに、Apidogを使用して、リクエストを受け入れ、レスポンスを返す実際のAPIサーバーの動作をシミュレートするMockサーバーを設定できます。詳細は
Mockサーバーの設定
を参照してください。
Apidogでの回帰テスト実行
#
Apidogで統合テストを設定した後、以下の方法で実行できます:
1.
手動実行
: 単一のリ クエストを実行するか、テストシナリオを実行してテストレポートを取得できます。詳細は
テストシナリオの実行
を参照してください。
2.
スケジュール自動化
: 「スケジュールタスク」を設定して、指定された時間に自動的に設定された自動テストシナリオを実行し、タスク実行結果を取得できます。これにより、定期的なテストや回帰テストの要件を満たすことができます。詳細は
スケジュールタスク
を参照してください。
3.
CI/CDパイプライン
: Apidog CLIを使用して、通常のアプリケーションビルドプロセスの一部としてテストシナリオを実行できます。コードプッシュのたびにテストスイートを実行し、Apidogでテストレポートを確認できます。詳細は
CI/CD統合
を参照してください。
Previous
統合テスト
Next
エンドツーエンド(E2E)テスト