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

テストケース

Apidog バージョン 2.7.29 以降、API詳細ページ上で直接テストケースを追加できるようになりました。
各テストケースは、APIに対する一連のリクエストパラメータを表します。ユーザーはすべてのテストケースを体系的に整理・管理でき、ワンクリックで実行して現在のAPIのテストを完了できます。
「テストケース」と「デバッグケース」の違い
テストケース
目的:APIがさまざまなリクエストシナリオで期待通りに動作するかを検証すること。網羅性を重視。
正常系、異常系、境界値、セキュリティなど、幅広いシナリオをカバー。
通常、修正や実行の頻度は低い。
デバッグケース
目的:開発やトラブルシューティング時にAPIのレスポンスを素早く確認すること。(スピード重視)
主に成功・失敗などの基本的なシナリオに限定。
頻繁に修正・実行される。

テストケースの作成方法#

テストケースは、以下の方法で作成できます。

1. 手動作成#

API詳細ページの「テストケース」タブで「+ケース追加」をクリックし、手動で作成します。

2. デバッグケースからインポート#

テストケース追加時に「デバッグケースからインポート」を選択し、既存のデバッグケースをテストケースとしてコピーまたは移動できます。
テストケースにコピー
デバッグケースを引き続き素早い検証に使いたい場合、同時にテストケースとしても利用したい場合に選択します。
テストケースに移動
デバッグケースが主に例外検証用で、今後デバッグ用途で頻繁に使わない場合に選択します。デバッグケースからテストケースへ直接変換されるため、もともとデバッグケースとして作成していた場合の移行がスムーズです。

テストケースの詳細#

テストケースには、以下の情報が含まれます。
グループ:テスト目的(正常系、異常系、境界値など)ごとに整理
ケース名:テストケースの名称
リクエストパラメータ:Path、Query、Header、form-data Body など
リクエストボディ:RAW、JSON、XML などに対応
前/後処理
レスポンス検証:検証の有効/無効切り替え、検証対象のレスポンス項目指定
※ テストケースは更新頻度が低いため、APIの仕様変更時は手動で同期が必要です。例えばAPIに新しいフィールドが追加された場合、テストケース内で「今すぐ同期」をクリックして内容を反映してください。
テストケースの内容を編集した場合は、「保存」をクリックして保存してください。未保存の変更がある場合、システムから通知されます。

テストケースの管理#

「テストケース」タブでは、作成済みのすべてのテストケースを管理できます。左上の検索・フィルター機能で目的のテストケースを素早く探せます。また、グループタブでグループごとに一覧表示も可能です。個別のテストケースに対しては以下の操作が可能です。
単一テストケース:新しいタブで詳細を開き、閲覧・編集・実行が可能。コピー、他グループへの移動、cURLコピー、削除などの基本操作も用意されています。
複数テストケース:リストで複数選択すると、右上に一括操作ボタンが表示され、グループ分け・削除・API更新との同期などがまとめて実行できます。

テストケースの実行#

テストケース閲覧時に「実行」ボタンをクリックすると、そのパラメータでリクエストが送信され、実際のレスポンスが表示されます。
「一括実行」や、リストから複数のテストケースを選択してまとめて実行することも可能です。画面上で、どのケースが実行中か、どのケースに結果があるかが一目で分かります。
一括実行後は、各テストケースを開いて実行結果を直接確認できます。

テストレポート#

テストを一括実行した後は、画面右上の「テストレポート」から過去のすべてのレポートを確認できます。
レポートをクリックすると、詳細な実行結果を確認でき、問題の追跡や分析に役立ちます。
テストケースの全体的な流れは以下の通りです。

単一APIテストのベストプラクティス#

単一APIのテストは、主にバックエンド開発者とQAエンジニアの2つの役割が関与します。
バックエンド開発者:APIの実装およびデバッグを担当
QAエンジニア:APIの網羅的なテストと問題発見を担当
ApidogでAPIごとにテストケースを管理できるようになったことで、以下のような効率的なワークフローが実現できます。
QAエンジニアはAPIドキュメント内で直接ユニットテストケースを作成・管理可能
開発者は既存のテストケースを用いて自らテストを実行し、結果を確認して即座に修正可能。QAエンジニアのフィードバックややり取りを待つ必要がありません
ベストプラクティスのワークフロー例:
このワークフローにより、チームのコラボレーション効率が向上します。
1.
APIドキュメント確定後、すぐにテストケースを作成でき、Apidog上で全メンバーが内容を確認可能
2.
開発者はデバッグ後、自分でAPIテストを実施でき、QAエンジニアの待機が不要
3.
テスト結果をもとに、開発者自身が直接修正可能。追加のチケット発行や手戻りが発生しません
4.
テスト結果が明確なため、問題の説明や認識違いが発生しにくくなります
Modified at 2025-09-18 10:44:35
Previous
設計優先 & リクエスト優先
Next
概要
Built with