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
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • データ & セキュリティ
    • Apidogのデータはどこに保存され、データセキュリティはどのように確保されていますか?
    • ユーザーデータはどのように保存されますか?このデータは公開されますか?それともプライベートですか?すべてのデータはクラウドに保存されますか?
    • リクエストを送信する際、Apidogサーバーを経由しますか?データセキュリティは確保されていますか?
  • アドオン
    • 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. 参考資料

よくある質問

1. Apidogは無料で利用できますか?#

Apidogのオープンソースバージョン(パブリックベータ版)が無料です。

2. Auth 状態をどのように実行しますか?#

Auth 状態の詳細はこちらをご覧ください。

3. APIがRequestを送信する前に、ログインAPIを呼び出して、TokenをHeaderに配置する必要がある場合、どのように実行しますか?#

Auth 状態の詳細はこちらをご覧ください。

4.API BのRequestパラメータがAPI Aに依存している場合、どのように実行しますか?#

API間でデータを渡す方法については、こちらのドキュメントをご覧ください。

5. 同じプロジェクトで異なるドメインがある場合、どうやって処理すればいいですか?#

方法 1:環境設定で異なるサービスを作成し、それに応じて異なるベースURL(プリフィックス URL)を設定します。APIグループとAPIディメンションは、特定のベースURLに関連付けることができますので、この方法をお勧めします。
方法 2:URLを環境変数に設定し、(例えば:「DOMAIN_1.」)、そしてAPIのPathを https:///users に設定します。APIのPathがhttp:// か https:// から始まる場合、システムは自動的にベースURLを無視します。
方法 3:異なるドメインに異なる環境を配置して、環境を切り替えて異なるドメイン下のAPIを実行します。この方法をお勧めしません。

6. Script 経由でAPIのRequestメッセージを読み取って編集するにはどうしたらいいですか?#

Scriptを使用してAPI Requestを読み取り/変更するためのドキュメントは、こちらをご覧ください。

7. データベースフィールドのQueryをAPIパラメータとして使用することをサポートしていますか?#

はい、サポートします。その詳細については、データベース操作をご覧ください。

8. データをどこで保存しますか?ローカルかクラウドか?オフラインでアクセスできますか?プライベートデプロイメントに対応していますか?#

Apidog Saasバージョンとプライベートデプロイメント両方対応しております。
Apidogのパブリックベータ版(SaaS)は無料で利用できますが、プライベートデプロイメントを有料で実施しております。
Saasバージョンの場合、データはクラウドで保存され、ネットワークに接続している場合にのみ使用できます。
プライベートデプロイメントの場合、データが組織内部に保存されるので、外部ネットワークに接続しなくても利用可能です。
:::tip ご注意:
環境変数/グローバル変数がローカルで保存され、クラウドに同期することもありませんし、 チームメンバー間で同期することもありませんので、Token、アカウント、パスワード、またはその他の秘密データを保存するために使用することをお勧めします。
:::

9. PostmanはAPIを期待どおりに呼び出しますが、Apidogでエラーを返するのはなぜですか?#

PostmanとApidogを使用して実際に送信したRequest 内容(URL、プラメータ、Body、Headerなど)が完全に一致しているかどうかを確認してください。
Apidog:Responseでの実際のRequestタブに移動して、実際に送信した内容を確認できます。
Postman:下部のステータスバーのコンソールをクリックすると、実際のRequestメッセージが表示されます。

10. 環境またはグローバル変数の値を変更しても、その引用先が変更しないのはなぜですか?#

1.
環境変数、グローバル変数、ローカル変数などの場所で同じ名前の変数が複数回定義されているかどうかを確認してください。変数の優先順位はローカル変数 > 環境変数 > グローバル変数になります。
2.
同じ名前の変数が複数ある場合、優先度が高い変数が利用されます。
3.
ローカル値を変更するかどうかを確認してください。環境変数とグローバル変数は、リモート値の代わりにローカル値のみ読み取っています。

11.Webアプリとデスクトップアプリの違いとはなんですか?#

ApidogのWebアプリとデスクトップアプリは、主な機能の利用中に違いがありません。どちらでもAPIを設計したり、開発したり、テストしたりすることができますが、以下の機能で違いがありますので要注意。
機能Webアプリ非対応デスクトップアプリ対応
APIのエクスポート×○
Agentサービス×○
ローカルMock×○
サーバースタブとクライアントSDK×○
外部プログラム×○
フォントサイズの調整×○
ネットワークプロキシ×○
"○"は対応していることを意味し、"×"は非対応を意味します。
Previous
用語の説明
Next
API-デザインファーストアプローチ
Built with