Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. API設計
  • 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
  1. API設計

複数のリクエストボディ例の設定

Apidogは、JSON、XML、Raw、MsgPackタイプのリクエストボディに対して複数の例を設定することをサポートしています。この機能は以下の用途に役立ちます:
異なるビジネスシナリオの例を設定する: 例えば、通常のリクエストと例外的なリクエスト。
OAS 3.0/3.1仕様への準拠: 標準的なOpenAPI仕様のエクスポートをサポート。
例の迅速な切り替え: デバッグや自動テスト時に便利。
multiple-request-body-examples.png

複数のリクエストボディ例の設定#

Apidogのバージョンは2.7.0以上である必要があります。
1
新しいリクエストボディ例を作成
APIドキュメントの編集ページに移動。
リクエストボディセクションを見つける。
+ 追加ボタンをクリックして、新しいリクエストボディ例を作成。
creating-new-request-body-example.png
2
リクエストボディ例を設定
例の名前(任意): 空白の場合、例1、例2などがデフォルトで設定されます。
例の値(必須): リクエストボディの実際の例データを提供。
説明(任意): 例を説明するための説明を追加。Markdown形式でのリッチテキストをサポート。
OAS Key(任意): OpenAPI仕様をエクスポートする際に使用。指定がない場合、シリアル番号が使用されます。
OAS拡張(カスタムフィールド): 提供された場合、エクスポート時に保持されます。
configure-request-body-example.png
3
リクエストボディ例を保存して使用
例を保存すると、使用可能になります。デバッグ中に、異なる例を簡単に選択してAPIをテストできます。
use-request-body-example-during-debugging.png
TIP
Rawタイプのリクエストボディの場合、デバッグ中に表示されるのは最初の例の値のみです。

リクエストパラメータを例として抽出#

1
リクエストパラメータを例として抽出
デバッグ中にリクエストボディを手動で設定し、それを例として保存したい場合は、抽出 -> Request例に抽出をクリックするだけです。
extract-request-parameters-as-examples.png
2
抽出オプションを選択
リクエストパラメータをどのように保存するかを選択するように求められます:
既存の例を上書き: 以前に保存された例を置き換える。
新しい例: 新しい例として保存。
choose-extraction-options.png
TIP
現在のデバッグ値はデフォルトで例に自動的に入力されます。

使用シナリオ#

デバッグ中のリクエストボディ例の使用#

1
APIドキュメントの実行ページに移動し、自動生成セクションを見つけます。
2
ドロップダウンメニューをクリックしてリクエストボディ例を選択します。例が自動的に入力されます。
switch-request-body-examples-debugging.png
3
リアルタイムで例を切り替え、選択した例でリクエストを送信できます。
高度な設定
自動生成の横にあるドロップダウンアイコンをクリックして、以下のオプションにアクセスします:
例: 事前定義されたリクエストボディ例から選択。
送信時に自動生成: モックルールに基づいてランダムな値を自動生成。
自動生成設定: より高度な設定については、リクエストの生成を参照してください。

ドキュメント表示#

単一のリクエストボディ例の場合: 例の名前を表示せずに簡略化されたビューで表示。
single-request-body-display.png
複数のリクエストボディ例の場合: 例の名前とMarkdown説明を表示し、並列レイアウトで例を切り替えることができます。
request-body-examples-display.png
TIP
リクエストボディ例の表示順序は以下の優先順位に従います:
1.
例の名前 > OAS Key > シリアル番号(1から自動インクリメント)。
2.
非空の項目が最初に表示されます。

OAS準拠#

OAS Key#

OAS Keyは、OpenAPI仕様をエクスポートする際の例のフィールド名を制御します。
1.
設定: リクエストボディ例にOAS Keyを入力します。
configuring-request-body-oas-key.png
2.
エクスポートルール:
入力されている場合: 提供されたOAS Keyがオブジェクトexamples内のフィールド名として使用されます。
入力されていない場合: シリアル番号(1から開始)がフィールド名として自動的に使用されます。
入力されている場合
入力されていない場合:

 "examples": {
   "example1": {
      "value": {
        "name": "Blake Keeling",
        "id": "165061",
        "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    },
    "example2": {
       "value": {
        "name": "Jolie Kutch",
        "id": "138164",
        "email": "Jolie_Kutch@hotmail.com"
      },
      "summary": "example 2",
      "description": "This is`example 2`"
    }
  }       
"examples": {
   "1": {
     "value": {
       "name": "Blake Keeling",
       "id": "165061",
       "email": "Blake.Keeling@gmail.com"
     },
     "summary": "example1",
     "description": "This is`example 1`"
   },
    "2": {
      "value": {
       "name": "Jolie Kutch",
       "id": "138164",
       "email": "Jolie_Kutch@hotmail.com"
     },
     "summary": "example 2",
     "description": "This is`example 2`"
   }
 }       

OAS拡張#

カスタムOpenAPI 仕様(OAS)拡張を例に追加できます。
1.
設定: OAS拡張フィールドにJSONのキーと値のペアを入力します。
{
  "x-demo": true,
  "x-scenario": "error_case"
}
add-oas-extensions-to-examples.png
2.
エクスポート効果: カスタムOAS拡張は完全に保持され、エクスポートされたOpenAPI仕様に含まれます。
"examples": {
    "example1": {
      "x-demo": true,
      "x-scenario": "error_case",
      "value": {
         "name": "Blake Keeling",
         "id": "165061",
         "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    }
}

よくある質問#

古いプロジェクトで複数のリクエストボディ例を有効にする方法は?
手動での操作は不要です!既存のAPIに2つ目のリクエストボディ例を追加すると、システムが自動的にフォーマットをアップグレードして複数の例をサポートします。
OASをエクスポートする際に複数のリクエストボディ例をどのように処理しますか?
エクスポートされたOASでリクエストボディ例の順序は変わりますか?
エクスポートされた例の名前をよりフレンドリーにする方法は?
Previous
APIの基本
Next
概要
Built with