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/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. リクエスト作成

パラメータとボディ

APIを使用する際、リクエストで様々なタイプのデータを送信する方法を理解することが重要だ。Apidogは、異なるパラメータとボディデータタイプを持つAPIリクエストの構築と送信を支援する使いやすいインターフェースを提供する。

パラメータ#

パラメータを使用すると、サーバーに追加情報を送信できる。Apidogは、クエリパラメータとパスパラメータの2つの主要なタイプをサポートしている。

Queryパラメータ#

クエリパラメータはURLの末尾に疑問符(?)の後に追加され、アンパサンド(&)で区切られる。サーバーにオプションまたは追加データを送信するために使用される。Apidogでは、APIリクエストのクエリパラメータを簡単に追加・管理できる。
クエリパラメータを追加する方法は2つある:
1.
URLに直接追加:アドレスバーのURL末尾に直接クエリパラメータを追加できる。
例:
https://api.example.com/users?page=1&limit=10
2.
Queryパラメータセクションを使用:ApidogはURL入力フィールドの下に専用のクエリパラメータセクションを提供する。ここで使いやすいインターフェースを使用してパラメータの追加、編集、削除ができる。このセクションで追加したパラメータは自動的にリクエストURLに追加される。

クエリパラメータの等号#

特殊なケースでは、クエリパラメータがキーと値のペアとして表示されないことがある。例えば:
https://api.example.com/users?available
この場合、available は空の値を持つパラメータとして機能する。値が空の場合、Apidogはキーと値の間の等号を自動的に省略する。
image.png
等号を省略したくない場合は、手動で「等号を追加」に変更できる。

Path パラメータ#

パスパラメータはURL自体の一部で、通常特定のリソースを識別するために使用される。URLで中括弧{}で囲まれたプレースホルダーで示される。
例:
https://api.example.com/users/{userId}
Apidogでは、上記のようにAPI URLでパスパラメータを定義でき、それらは下のパスパラメータセクションに表示される。パスパラメータセクションで値を入力し、リクエスト送信時に {param} が実際の値に置き換えられる。この機能は、URLでリソース識別子を使用するRESTful APIのテストに特に役立つ。
image.png
パスパラメータで変数を使用する場合、URLで {param} を使用し、パラメータの値で {{変数}} を使用することを推奨する。

Body#

リクエストボディは、POST、PUT、またはPATCHリクエストの一部としてサーバーにデータを送信するために使用される。Apidogは様々なボディデータ形式をサポートし、異なるAPI要件に対応する。

Form-Data#

form-dataは、HTMLフォームの送信に似たキーと値のペアを送信する方法だ。この形式は、ファイルを他のデータと共にアップロードする必要がある場合に特に便利。
image.png
form-dataタイプのボディはリクエストで multipart/form-data として表示される。ボディの各パラメータについて、文字列、整数などのタイプを選択できる。
form-dataでJSONを送信する必要がある場合は、パラメータタイプを文字列に設定し、文字列フィールドにJSONを入力する。
リクエストでファイルを送信する場合は、タイプをファイルとして選択し、「アップロード」をクリックしてローカルファイルを選択する。
Apidogはリクエストでファイルを送信するだけで、クラウドにファイルを保存しない。そのため、チームでの協業時、他のメンバーはこのリクエストを見ることはできるが、直接このファイルを送信することはできない。同僚がファイルを送信できるようにするには、別の手段でファイルを転送する必要がある。

x-www-form-urlencoded#

この形式はクエリパラメータに似ているが、リクエストボディで送信される。ファイルアップロードのない単純なフォームの送信によく使用される。Apidogでは、キーと値のインターフェースを使用してx-www-form-urlencodedデータを簡単に追加・編集できる。

JSON#

JSON(JavaScript Object Notation)はAPIリクエストとレスポンスで一般的なデータ形式だ。Apidogは構文強調と検証機能を備えたJSONエディタを提供し、APIリクエストのJSONペイロードを簡単に構築・編集できる。
JSONにコメントを追加したい場合は、設定 - 一般設定 - 機能設定 - 詳細設定で「注釈付きJSONをサポート」を有効にできる。JSON送信時、これらのコメントは自動的に削除される。

XML#

XML(eXtensible Markup Language)はAPI通信で使用される別の一般的なデータ形式だ。ApidogはXMLペイロードをサポートし、APIリクエストで構造化されたデータをXML形式で送信できる。

raw#

rawオプションでは、リクエストボディで任意のカスタムデータ形式を送信できる。他のオプションでカバーされていない特定のデータ構造や形式を期待するAPIで作業する場合に便利。

binary#

バイナリデータはこのオプションを使用して送信でき、ファイルのアップロードやバイナリペイロードを期待するAPIとの作業時に特に便利。Apidogでは、APIリクエストの一部としてバイナリファイルを選択・送信できる。

GraphQL#

GraphQLを使用するAPIでは、Apidogは専用のGraphQLエディタを提供する。この機能により、構文強調とオートコンプリート機能を備えたGraphQLクエリとミューテーションを構築・送信できる。
詳細については、ApidogのGraphQLを参照。

msgpack#

MessagePack(msgpack)はJSONよりもコンパクトで高速なバイナリシリアライゼーション形式だ。Apidogはmsgpackデータの送信をサポートしており、パフォーマンスとデータ転送の削減に最適化されたAPIで作業する場合に有効。
Previous
リクエストの基本
Next
リクエストヘッダー
Built with