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
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • 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ドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • LLM最適化機能
    • 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
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • データ & セキュリティ
    • Apidogのデータはどこに保存され、データセキュリティはどのように確保されていますか?
    • ユーザーデータはどのように保存されますか?このデータは公開されますか?それともプライベートですか?すべてのデータはクラウドに保存されますか?
    • リクエストを送信する際、Apidogサーバーを経由しますか?データセキュリティは確保されていますか?
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • OpenAPIアクセストークンの生成
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データバックアップ
    • Apidogの更新
    • アカウント削除
    • 試験的な機能
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. スクリプト利用

JavaScriptライブラリの利用

Apidogではスクリプト内で組み込みおよび非組み込みのJavaScriptクラスライブラリを利用できます。
1.
組み込みJSクラスライブラリ
Apidogの組み込みJSライブラリはrequireで使用可能です。
2.
非組み込みJSクラスライブラリ
npmで公開されている多数の非組み込みライブラリを$$.liveRequire関数で動的に導入できます。純粋なJSライブラリのみ対応しており、ブラウザ側動作をサポートする「browser」記載のライブラリが推奨です。C/C++などの言語拡張を含むライブラリは読み込み不可で、タイムアウトまたは例外が発生します。
TIP
非組み込みライブラリはネットワークからJSライブラリをダウンロードする必要があるため、インターネット接続が必須です。実行時のライブラリダウンロードにはパフォーマンス低下が伴うため、まず組み込みJSライブラリの利用を推奨します。

組み込みライブラリ一覧#

エンコード/デコード
atob(v2.1.2): Base64デコード
btoa(v1.2.1): Base64エンコード
crypto-js(v3.1.9-1): エンコード/デコードライブラリ(Base64、MD5、SHA、HMAC、AES等)
モジュール全体のみrequire可能でサブモジュールは不可
jsrsasign(10.3.0): RSA暗号化/復号(Apidogバージョン1.4.5以降のみ対応)
アサーション
chai (v4.2.0): BDD/TDDアサーションライブラリ
ツール
postman-collection(v3.4.0): Postmanコレクションライブラリ
cheerio(v0.22.0): jQueryサブセット
lodash (v4.17.11): JSユーティリティライブラリ
moment(v2.22.2): 日付ライブラリ(ロケール除く)
uuid: UUID生成
xml2js(v0.4.19): XML→JSON変換
csv-parse/lib/sync( v1.2.4): CSV解析
JSONSchemaバリデーター
tv4(v1.3.0): JSONSchemaバリデーター
ajv(v6.6.2): JSONSchemaバリデーター
組み込みNodeJSモジュール
path
assert
buffer
util
url
punycode
querystring
string-decoder
stream
timers
events

使用例#

以下に組み込みライブラリを用いたデータの暗号化・復号、エンコード・デコードの一般的な例を示します。

SHA256暗号化#

HMAC-SHA256暗号化#

Base64エンコード#

Base64デコード#

文字列デコード:
JSONデコード:
pm.response.setBody()メソッドでデコードしたJSONデータをレスポンスボディに設定可能です。

AES暗号化#

AES復号#

ECBモードとPkcs7パディングでAES暗号化された暗号文の復号スクリプト例:

RSA暗号化#

RSA復号#

以下はシンプルなRSA暗号化/復号の完全な例(注: jsrsasignバージョン10.3.0、他のバージョンと構文互換性なし)。この例はNode.js環境で実行可能で、Apidogでの暗号化/復号操作に適応できます:
image.png
TIP
組み込みライブラリを使用する場合、モジュール全体のみrequire可能で、サブモジュールを個別にrequireすることはできません。
// 正しい例
var cryptoJs = require("crypto-js");
console.log(cryptoJs.SHA256("Message"));

// 誤った例
var SHA256 = require("crypto-js/sha256");
console.log(SHA256("Message"));
Modified at 2025-06-27 10:31:41
Previous
他のプログラミング言語の呼び出し
Next
レスポンスの可視化
Built with