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ドキュメントのリアルタイムコラボレーション機能は、R&Dチームの作業効率を向上させ、繰り返しのコミュニケーションコストを削減します。API管理のHTTP APIとデータモデルモジュールは、複数ユーザーによるオンラインリアルタイムコラボレーションをサポートしています。他のメンバーがデータを保存すると、現在のページは自動的に他のチームメンバーによる変更を更新します。

適用シナリオ#

以下のシナリオでは、新しいAPIドキュメントが手動でのグローバルリフレッシュなしにチームメンバーに自動的に同期されます:
アプリ内でAPIを修正して保存する
Swagger/OpenAPIファイルを定期的にインポートした後

ハイライト#

他の類似製品と比較して、Apidogの複数ユーザーコラボレーション機能には以下のような大きな利点があります:
エディターのアバターをリアルタイムで表示し、誰が同じAPIを編集しているかを明確に示す
フィールドレベルでのコラボレーションにより、コンテンツの競合を効果的に回避
競合が発生した場合、編集中に知ることができ、事前に解決して編集を続けることが可能
細かい競合解決により、両方の側から部分的なコンテンツを保持することが可能
APIドキュメントにはバージョン履歴とゴミ箱があり、古いバージョンへのロールバックをサポートし、誤った変更を心配する必要がない
自動インポートとIDEAプラグインもリアルタイムコラボレーションの一部であり、インポート後にデータが自動的に更新される

コラボレーションリンク#

「コラボレーションリンク」機能を使用すると、チームメンバーがAPIを迅速に特定し、コラボレーションを行うことができます。
コラボレーションリンクはチーム内での共有にのみ使用され、チーム外のメンバーはコラボレーションリンクを開くことができません。

コラボレーションリンクをコピーする#

APIの右側のメニューバーにある「コラボレーションリンクをコピー」ボタンをタップして、コラボレーションリンクを作成します。それを他のチームメンバーに送信し、リンクを開くと、ウェブターミナルで対応するAPIを直接特定できます。

リンクURLの仕様#

Apidogリンクは、いくつかの主要なコンポーネントで構成されています:
1.
プロジェクトID
例: https://apidog.com/web/project/{Project-ID}
2.
プロジェクト内の指定されたAPI
例: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}
3.
API内の指定されたタブ
例: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}-run
このURL構造により、ユーザーはApidogプラットフォーム内の特定のプロジェクト、API、およびビューにアクセスできます。

URLにパラメータ値を埋め込む#

ApidogのAPIを共有する際、デフォルトではAPI仕様のみが含まれ、パラメータ値は含まれません。しかし、特定のパラメータや変数値を含めてドキュメントを共有する必要がある場合、ドキュメントURLに直接埋め込むことができます。

パラメータ値の渡し方#

URLにパラメータ値を埋め込む方法は、シンプルモードと複雑モードの2つがあります。シンプルモードはより簡単でURLエンコードを必要としませんが、ブラケット文字をサポートしていません。複雑モードはすべての文字をサポートしますが、パラメータデータのエンコードが必要です。

シンプルモード#

シンプルモードでは、query[xxx]=yyyの形式を使用して、xxxという名前のパラメータにyyyという値を割り当てることができます。
例:
https://apidog.com/web/project/406014/apis/api-10061199-run?query[aaa]=yyy&query[bbb]=yyy&path[aaa]=yyy&body[aaa]=yyy&header[aaa]=yyy&cookie[aaa]=yyy&environment[aaa]=yyy
パラメータタイプパラメータ値説明
クエリパラメータquery[xxx]=yyy
パスパラメータpath[xxx]=yyy
ボディパラメータbody[xxx]=yyyform-dataまたはx-www-urlencodedボディタイプの場合
ボディパラメータbody=yyyその他のボディタイプの場合
ヘッダーパラメータheader[xxx]=yyy
クッキーパラメータcookie[xxx]=yyy
環境変数environment[xxx]=yyyこれらはデフォルトの環境変数に保存されます

複雑モード#

複雑モードでは、JSONオブジェクトをエンコードすることで、より高度なパラメータ埋め込みが可能です。paramsパラメータの値は、以下のJSONデータに対してencodeURIComponentを呼び出すことで取得されます:
{
    "query": [
        ["id", "value1"], 
        ["id", "value2"], 
        ["key2", "value3"]
    ],
    "path": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ],
    "body": [
        ["aaa", "value1"], 
        ["key2", "value2"]
    ],
    "header": [
        ["testHeader", "value1"], 
        ["key2", "value2"]
    ], 
    "cookie": [
        ["testCookie", "value1"], 
        ["key2", "value2"]
    ], 
    "environment": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ]
}
エンコードされたURLは次のようになります:
https://apidog.com/web/project/406014/apis/api-10061199-run?params={ "query"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "body"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "cookie"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "environment"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" } }
パラメータタイプパラメータ値説明
クエリパラメータquery
パスパラメータpath
ボディパラメータbodyボディタイプがform-dataまたはx-www-urlencodedの場合、ボディの値はJSON; それ以外の場合、ボディの値は文字列
ヘッダーパラメータheader
クッキーパラメータcookie
環境変数environmentこれらはデフォルトの環境変数に保存されます

環境変数の渡し方#

URLを使用してユーザーの「環境変数」を自動的に設定することもできます。これを行うには、environment[変数名]=変数値の形式でURLパラメータを追加します。
例えば:
https://apidog.com/web/project/406014?environment[aaa]=xxx&environment[bbb]=yyy
https://apidog.com/web/project/406014/apis/api-10061199-run?environment[aaa]=xxx

開き方を変更する#

コラボレーションリンクは、クライアントとウェブの両方で開くことをサポートしています。クライアントを通じてAPIを特定したい場合は、Apidog Webにアクセスし、「設定」⚙をタップし、「協業用リンクを常にデスクトップアプリで開く」オプションを「一般」でオンにします。
このオプションはApidog Webでのみ利用可能で、Apidogクライアントでは利用できません。
コラボレーションリンクにアクセスすると、クライアントが自動的に起動されます。
Previous
データベース接続
Next
プロジェクト管理
Built with