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. スクリプト利用

Postmanスクリプトリファレンス

pm#

pmオブジェクトは、APIやテストコレクションの実行に関連する情報を含んでいる。リクエストやレスポンスのデータで使用でき、環境変数やグローバル変数の取得や設定ができる。
pm.info.eventName:String:現在実行中のスクリプトのタイプ(前処理スクリプトまたは後処理スクリプト)
pm.info.iteration:Number:現在の繰り返し回数(テストコレクションでのみ有効)
pm.info.iterationCount:Number:総繰り返し回数(テストコレクションでのみ有効)
pm.info.requestName:String:現在実行中のAPIの名前
pm.info.requestId:String:現在実行中のAPIのID

pm.sendRequest#

pm.sendRequest:Function
pm.sendRequestは、スクリプト内で非同期にHTTP/HTTPSリクエストを送信するために使用する。
このメソッドは、コレクションSDKと互換性のあるリクエストパラメータとコールバック関数パラメータを受け付ける。コールバックには2つの引数がある。1つ目はエラー、2つ目はコレクションSDKと互換性のあるレスポンスだ。詳しくはCollection SDKドキュメントを参照。
前処理スクリプトと後処理スクリプトの両方で使用できる。
詳細については以下を参照してね:
Request JSON構造
Responseの構造

pm.variables#

pm.variables: Variable SDKのドキュメントを参照。
ローカル変数。変数の優先順位は以下の通り:
ローカル変数 > 環境変数 > プロジェクト内で共有されるグローバル変数 > チーム内で共有されるグローバル変数
pm.variables.has(variableName:String):function → Boolean:一時変数が存在するかチェックする
pm.variables.get(variableName:String):function → *:一時変数を取得する
pm.variables.set(variableName:String, variableValue:String):function → void:一時変数を設定する
pm.variables.replaceIn(variableName:String):function:文字列内の「動的変数」(例:{{variable_name}})を実際の値に置き換える。例:
pm.variables.replaceInAsync(variableName:String):function:文字列内の「動的値の式」(例:{{$person.fullName}})を実際の値に置き換える。このメソッドはPromiseを返すため、呼び出し時にawaitを使用する必要がある。例:
pm.variables.toObject():function → Object:すべてのローカル変数をオブジェクトとして取得する

pm.iterationData#

pm.iterationData:
テストデータ変数
現在、テストデータは別個に管理されているため、スクリプト内で直接テストデータ変数を設定することはサポートしていない。ただし、以下のように変数にアクセスすることはできる:
pm.iterationData.has(variableName:String):function → Boolean:テスト変数が存在するかチェックする
pm.iterationData.get(variableName:String):function → *:テスト変数を取得する
pm.iterationData.replaceIn(variableName:String):function:文字列内の動的変数(例:{{variable_name}})を実際の値に置き換える
pm.iterationData.toObject():function → Object:すべてのローカル変数をオブジェクトとして取得する

pm.environment#

pm.environment.name:String:環境名
pm.environment.has(variableName:String):function → Boolean:環境変数が存在するかチェックする
pm.environment.get(variableName:String):function → *:環境変数を取得する
pm.environment.set(variableName:String, variableValue:String):function:環境変数を設定する
pm.environment.replaceIn(variableName:String):function:文字列内の動的変数(例:{{variable_name}})を実際の値に置き換える
pm.environment.toObject():function → Object:すべてのローカル変数をオブジェクトとして取得する
pm.environment.unset(variableName:String):function:環境変数を解除する
pm.environment.clear():function:現在の環境下のすべての環境変数をクリアする
TIP
上記の操作はすべて「現在の値」の読み書きのみを行い、「リモートの値」の読み書きは行わない。

pm.globals#

pm.globals.has(variableName:String):function → Boolean:グローバル変数が存在するかチェックする
pm.globals.get(variableName:String,variableScope:String):function → *: グローバル変数を取得する。変数のスコープを指定するには「PROJECT」(デフォルト)または「TEAM」を使用。
pm.globals.set(variableName:String,variableValue:String,variableScope:String):function: グローバル変数を設定する。変数のスコープを指定するには「PROJECT」(デフォルト)または「TEAM」を使用。
pm.globals.replaceIn(variableName:String):function:文字列内の動的変数(例:{{variable_name}})を実際の値に置き換える
前処理スクリプトで変数を含むリクエストパラメータの値を取得するには、pm.globals.replaceInを使用して変数を実際の値に置き換える
pm.globals.toObject():function → Object: すべてのグローバル変数をオブジェクトとして取得する。
pm.globals.unset(variableName:String,variableScope:String):function: グローバル変数を解除する。変数のスコープを指定するには「PROJECT」(デフォルト)または「TEAM」を使用。
pm.globals.clear():function:現在の環境下のすべてのグローバル変数をクリアする
TIP
1.
上記のすべての操作は「初期値」ではなく、「現在の値」にのみ影響を与えるよ。
2.
「TEAM」スコープでセットを使うと、既存のチーム変数の現在の値だけが更新されるんだ。もしチーム変数が存在しない場合は、新しく作成されることはなく、その変数はローカル変数として扱われるよ。

pm.request#

pm.request:詳しくはRequest SDKドキュメントを参照。
requestはAPIリクエストオブジェクトだ。前処理スクリプトでは、これから送信されるリクエストを指し、後処理スクリプトでは、既に送信されたリクエストを指す。
requestには以下の情報が含まれる:
pm.request.url:Url:現在のリクエストのURL
pm.request.getBaseUrl():現在の実行環境で選択されたBASE URLを取得する。この機能はバージョン2.1.39以降でサポートされている
pm.request.headers:HeaderList:現在のリクエストのヘッダーリスト
pm.request.method:String:現在のリクエストのメソッド(GETやPOSTなど)
pm.request.body:RequestBody:現在のリクエストのボディ
pm.request.headers.add({ key: headerName:String, value: headerValue:String}):function:現在のリクエストにヘッダーを追加する
pm.request.headers.remove(headerName:String):function:現在のリクエストからヘッダーを削除する
pm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function:現在のリクエストのヘッダーを更新または追加する。キーが既に存在する場合は修正される
以下のAPIは後処理スクリプトでのみ使用できる。

pm.response#

pm.response:詳しくはResponse SDKドキュメントを参照。
後処理スクリプトで返信レスポンス情報にアクセスするにはpm.responseを使用する。
pm.responseには以下の情報が含まれる:
pm.response.code:Number
pm.response.status:String
pm.response.headers:HeaderList
pm.response.responseTime:Number
pm.response.responseSize:Number
pm.response.text():Function → String
pm.response.json():Function → Object

pm.cookies#

pm.cookies:詳しくはCookieList SDKドキュメントを参照。
Cookiesは現在のリクエストのドメイン名の下にあるクッキーのリストだ。
pm.cookies.has(cookieName:String):Function → Boolean
cookieName のクッキー値が存在するかチェックする
pm.cookies.get(cookieName:String):Function → String
cookieName からクッキー値を取得する
pm.cookies.toObject:Function → Object
現在のドメインの下にあるすべてのクッキーをオブジェクトとして取得する
pm.cookies.jar().clear(pm.request.url)
すべてのクッキーをクリアする
TIP
pm.cookiesはAPIリクエストの後に返されるクッキーであり、APIリクエストによって送信されるクッキーではない。

pm.test#

この関数は、結果が期待通りかどうかをアサートするために使用する。
以下の例は、レスポンスが正しいかどうかを判断するために使用できる:
コールバック関数でdone(オプションパラメータ)を使用して、非同期テストを実行できる:
pm.test.index():Function → Number
特定の場所からのテストの総数を取得する

pm.expect#

pm.expectはアサーションメソッドだ。ChaiJS expects BDDライブラリのドキュメントを参照してね。
このメソッドは、レスポンスや変数内のデータをアサートするために設計されている。pm.expectの例についての詳細は、アサーションライブラリの例を参照してね。

pm.response.to.have.*#

pm.response.to.have.status(code:Number)
pm.response.to.have.status(reason:String)
pm.response.to.have.header(key:String)
pm.response.to.have.header(key:String, optionalValue:String)
pm.response.to.have.body()
pm.response.to.have.body(optionalValue:String)
pm.response.to.have.body(optionalValue:RegExp)
pm.response.to.have.jsonBody()
pm.response.to.have.jsonBody(optionalExpectEqual:Object)
pm.response.to.have.jsonBody(optionalExpectPath:String)
pm.response.to.have.jsonBody(optionalExpectPath:String, optionalValue:*)
pm.response.to.have.jsonSchema(schema:Object)
pm.response.to.have.jsonSchema(schema:Object, ajvOptions:Object)

pm.response.to.be.*#

組み込みのpm.response.to.beを使用して、クイックアサーションを行うことができる:
pm.response.to.be.info
ステータスコードが1XXかどうかをチェックする
pm.response.to.be.success
ステータスコードが2XXかどうかをチェックする
pm.response.to.be.redirection
ステータスコードが3XXかどうかをチェックする
pm.response.to.be.clientError
ステータスコードが4XXかどうかをチェックする
pm.response.to.be.serverError
ステータスコードが5XXかどうかをチェックする
pm.response.to.be.error
ステータスコードが4XXまたは5XXかどうかをチェックする
pm.response.to.be.ok
ステータスコードが200かどうかをチェックする
pm.response.to.be.accepted
ステータスコードが202かどうかをチェックする
pm.response.to.be.badRequest
ステータスコードが400かどうかをチェックする
pm.response.to.be.unauthorized
ステータスコードが401かどうかをチェックする
pm.response.to.be.forbidden
ステータスコードが403かどうかをチェックする
pm.response.to.be.notFound
ステータスコードが404かどうかをチェックする
pm.response.to.be.rateLimited
ステータスコードが429かどうかをチェックする
Previous
後処理スクリプト
Next
共通スクリプト
Built with