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の定義が開発・デプロイされた後、その変更の一部または全てをメインブランチにマージするオプションがあります。

スプリントブランチのマージ方法#

スプリントブランチにいる場合、API管理モジュールの横にあるブランチ切り替えボタンの隣に「マージ」ボタンが表示されます。また、API管理モジュールの右下にも「メインにマージ」ボタンが表示されます。
Apidog スプリントブランチのマージエントリーポイント
自動テストでは、個々のテストシナリオは個別にマージする必要があり、API管理モジュールのリソースとは自動的にマージされません。スプリントブランチにいる場合、自動テストのテストシナリオ横にある...ボタンにカーソルを合わせると、「メインにマージ」ドロップダウンオプションが表示されます。
Apidog テストシナリオのマージエントリーポイント

保護されていないメインブランチへのマージ#

メインブランチが保護されていない場合、プロジェクトのマージ権限を持つユーザーは変更を確認し、直接メインブランチにマージできます。

保留中のマージの概要#

API管理モジュールで「マージ」ボタンをクリックすると、マージ概要ポップアップが開きます。
Apidog マージ概要
このポップアップでは、以下の主要な要素が表示されます:
フィルター: 現在のスプリントブランチでメインブランチと比較して変更されたリソースのみを表示するか、現在のスプリントブランチの全てのリソースを表示するかを選択できます。デフォルトでは、変更されたリソースが表示され、ユーザーが変更点に集中できるようになっています。
マージプレビュー: このセクションでは、現在のスプリントブランチをマージした後のメインブランチのディレクトリ構造が表示されます。このディレクトリを使用して、マージ後のリソースの配置と内容を確認できます。ディレクトリ内のリソースは、色付きのドット(灰色:未変更、オレンジ:変更済み、緑:新規)でステータスが示されます。右側のチェックボックスを使用して、メインブランチにマージするリソースを選択または選択解除できます。
マージ後のAPIステータス: マージ後のリソースのステータスを調整する方法を選択できます。オプションは現在のブランチに従う、メインに従う、または指定されたステータスです。

保留中のマージの詳細確認#

マージ概要ポップアップでは、フォルダ内のコンテンツに対して追加の操作を行い、リソースをメインブランチにマージすべきかどうかを確認できます。リソースをクリックすると、ポップアップが展開され、詳細な内容が表示され、マージの判断を支援します。
異なるリソースには異なるマージロジックと詳細があります:
新規リソース:
新規リソースとは、現在のスプリントブランチで作成され、メインブランチには存在しないリソースを指します。
マージすると、指定された場所にリソースがメインブランチに作成されます。
クリックすると、このリソースの完全な内容が表示されます。以下の画像を参照してください。
Apidog 新規リソースの詳細
変更済みリソース:
変更済みリソースとは、メインブランチから現在のスプリントブランチにフォークされ、メインブランチのリソースに関連付けられているリソースを指します。
マージすると、メインブランチのリソースが上書きされます。
クリックすると、メインブランチのリソースとの変更点と完全な内容が表示されます。以下の画像を参照してください。
Apidog 変更済みリソースの詳細
未変更リソース:
未変更リソースとは、メインブランチからフォークされ、現在のスプリントブランチで変更されていないリソースを指します。
未変更リソースはマージ対象として選択できません(また、選択する必要もありません)。
クリックしても、このリソースの詳細な内容は表示されません。以下の画像を参照してください。
Apidog 未変更リソースの詳細
右下のマージボタンをクリックすると、フォルダ内の選択された全てのリソースがスプリントブランチの設定に従ってメインブランチにマージされます。親リソースが選択されていない場合、その子リソースは個別にマージできないことに注意してください。
Apidog マージ確認ポップアップ
マージ後、トーストメッセージが表示され、操作の成功が確認されます。マージポップアップが閉じ、メインブランチへの変更を確認するためのサマリーポップアップが開きます。
Apidog マージ完了ポップアップ

メインブランチでのマージ詳細の確認 / マージの取り消し#

メインブランチでリソースの変更履歴にアクセスすると、マージを通じて変更された内容が表示され、詳細な変更を確認できます。また、他のバージョンとの内容を比較することもでき、変更の追跡やロールバックが容易になります。
Apidog メインブランチのリソース履歴
Apidog メインブランチのリソース履歴

保護されたメインブランチへのスプリントブランチのマージ#

保護されたメインブランチにスプリントブランチの変更をマージする場合、編集権限のみを持つユーザーはマージリクエストを作成する必要があります。プロジェクト管理者がリクエストを確認し、承認した後に変更が適用されます。

マージリクエストの作成#

プロジェクトでマージをクリックすると、保護されていないメインブランチへのマージと同様に動作し、現在のブランチの全ての変更を確認できます。ここから、メインブランチにマージする特定のリソースを選択できます。選択後、右下のマージリクエストを作成ボタンをクリックして、レビューのためにリクエストを提出します。
マージリクエストの作成

マージリクエストのレビュー#

マージリクエストが作成されると、レビュアーはプロジェクト概要に新しいマージリクエストが提出されたことを示す明確な通知を見ることができます。レビューするには、プロジェクト概要 > マージリクエストに移動し、リクエストのリストと詳細情報を確認します。
マージリクエストのレビュー
保留中のマージリクエストをクリックすると、レビュアーはマージリクエストの内容を評価できます。マージ前後の内容を詳細に比較し、リクエストを承認するかどうかを決定できます。マージを進める場合、右下のマージボタンをクリックすると、現在のリクエストの全ての変更がメインブランチにマージされます。
メインブランチへのマージリクエスト
マージプロセスは保護されていないメインブランチへのマージと同じロジックに従います。
マージが完了すると、変更がメインブランチにマージされ、メインブランチへの変更を示す概要表が表示されます。
変更概要
マージリクエストのステータスもマージ済みに更新されます。クリックすると、マージされたリクエストの詳細が表示されます。
マージ済みリクエストのステータス

提出済みマージリクエストの修正#

マージリクエストを提出した後、レビュアーから変更を求められる場合や、承認前に調整が必要な場合があります。そのような場合、スプリントブランチで直接内容を修正できます。これらの変更は既存のマージリクエストと自動的に同期され、新しいリクエストを作成する必要はありません。修正内容はマージリクエストのレビューページに表示されます。
提出済みマージリクエストの修正

マージリクエストの拒否#

レビュアーがマージリクエストがスプリントブランチに適していないと判断した場合、マージリクエストのレビューページで拒否をクリックできます。拒否されると、マージリクエストはクローズとマークされます。変更を加えて再度マージを試みるには、新しいマージリクエストを作成する必要があります。
マージリクエストの拒否
クローズされたマージリクエストをクリックすると、全ての詳細が表示されます。
クローズされたマージリクエストの詳細

自動テストシナリオのマージ#

自動テストシナリオとAPIは現在、独立して個別にマージされます。テストシナリオは個別にマージする必要があり、全体のマージページはありません。
重要な注意点:
1.
テストシナリオをマージする前に、まずAPI管理モジュールのリソースをマージしてください。これを怠ると、マージ後にメインブランチの関連テストシナリオが正常に動作しなくなる可能性があります。
2.
現在、保護されたメインブランチにテストシナリオをマージできるのはプロジェクト管理者のみです。ただし、将来的には、APIマージリクエストと同様に、テストシナリオのマージリクエストを提出できる機能を実装する予定です。これにより、保護されたメインブランチへのテストシナリオのマージが容易になります。
スプリントブランチにいる場合、自動テストのテストシナリオ横にある...ボタンにカーソルを合わせると、「メインにマージ」オプションが表示されます。
Apidog テストシナリオのマージエントリーポイント
これをクリックすると、テストシナリオのマージポップアップが開き、以下の情報が表示されます:
基本情報: マージ対象のスプリントブランチのテストシナリオと、関連するメインブランチのテストシナリオ(存在する場合)が表示されます。
最終実行結果: スプリントブランチでのテストシナリオの最後の手動実行結果が表示されます。アイコンにカーソルを合わせると、結果の概要が表示されます。テスターはこの情報を使用して、マージを進めるかどうかを判断できます。結果が未テストまたは失敗の場合、マージ前にテストシナリオが完全に合格することを確認することを推奨します。
マージアクション: オプションは上書きと追加です。テストシナリオがメインブランチからフォークされた場合、メインブランチのリソースを上書きしてマージされます。テストシナリオが新規の場合、メインブランチに追加されます。
Apidog テストシナリオのマージポップアップ
Previous
ブランチでAPIの設計
Next
概要
Built with