Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
環境 & 変数
Copy Page
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固有識別子
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
環境 & 変数
Copy Page
Apidogの環境と変数
Apidogでは、変数は複数のAPIリクエストやスクリプトで使用できる値の動的なプレースホルダーとして機能します。リクエストやスクリプトを実行する際、Apidogはその変数の現在の値を参照します。変数を環境ごとにグループ化することで、異なる作業シナリオに合わせてテスト設定を簡単に調整できます。
変数の使い方
#
Apidogでの変数の作成と使用方法は以下の通りです:
1
すべてのユーザーのチームスペースにプリインストールされているデフォルトのPetStoreプロジェクトを開きます。
2
インターフェース右上の環境アイコン「
≡
」をクリックします。
3
「グローバル変数」セクションで、「my_variable」という名前の新しい変数を作成し、初期値として「123」を設定します。
4
「保存」ボタンをクリックします。
5
「Find pet by ID」APIを開き、「
実行タブ
」に切り替えます。
6
パスパラメータ「PetId」を見つけ、値として「
{{my_variable}}
」を入力します。
7
変数名にカーソルを合わせると、現在の値とスコープが表示されます。
8
「
≡
」アイコンの横にある環境ドロップダウンをクリックし、「Local Mock」環境に切り替えます。
9
「
実行
」をクリックしてリクエストを送信します。
10
インターフェースの下半分にレスポンスが表示されます。「
実際のリクエスト
」タブに切り替えると、変数が実際の値に置き換えられて送信されたリクエストを確認できます。
Apidogでの変数の詳細については、
変数の使用
を参照してください。
環境の作成と切り替え
#
「環境」という用語は開発チームでよく使用され、「開発環境」「テスト環境」「本番環境」などを区別します。各環境は1つまたは複数のサーバーで構成されています。クライアントが特定の環境にある場合、すべてのリクエストはその環境のサーバーに送信されます。環境を切り替えると、リクエストは異なるサーバーセットに転送されます。
環境とサービス
についての詳細はこちらをご覧ください。
Modified at
2025-02-25 09:12:17
Previous
設計優先 & リクエスト優先
Next
環境管理