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の設計

新しく作成されたスプリントブランチには、デフォルトでは何も含まれていません。このアプローチにより、開発者は現在のスプリントで必要な変更に集中できます。スプリントブランチ内でリソースを追加し、変更を加える主な方法は2つあります。
手動変更: Apidogでリソースを手動でインポートまたは作成し、必要な変更を加えることができます。この方法は、APIファースト開発アプローチを採用しているチームに最適で、Apidogはその効果を高く評価しています。
OASインポート: 代わりに、OpenAPI仕様(OAS)をスプリントブランチに直接インポートすることもできます。インポートプロセス中、ApidogはOASの内容をメインブランチのAPIと自動的に比較し、関連するリソースや新しいリソースを生成します。また、変更されたOASを同じスプリントブランチに複数回インポートして、内容を更新することもできます。この方法は、コードファースト開発アプローチを好むチームに最適です。
特定のシナリオと要件に最も適した方法を選択してください。1つのスプリントブランチでの変更は、そのブランチのデータにのみ影響し、メインブランチや他のブランチには影響しません。

手動変更#

スプリントブランチ内で手動で内容を変更することを強く推奨します。この方法では、リソースを手動で選択または作成することで、開発に着手する前にAPI仕様を明確に定義でき、効率が向上し、コラボレーションコストが削減されます。

メインブランチからリソースをフォークする#

現在のスプリントの要件に基づいて既存のAPI、スキーマ、またはレスポンスコンポーネントを変更およびアップグレードする必要がある場合、Fork from mainを使用して、必要なリソースのコピーを現在のスプリントブランチに作成します。
Apidog Importing Resources from Main Branch
リソースをインポートすると、その親フォルダも自動的に現在のスプリントブランチのフォルダにインポートされ、正確なフォルダ階層が保証されます。メインブランチからインポートされたリソースは、フォルダ内で関連付けを示す表示がされます。
Apidog Importing Resources from Main Branch
現在、APIケースはデフォルトでAPIと一緒にスプリントブランチにインポートされます。同様に、インポートされたAPIケースもフォルダ内で関連付けを示す表示がされます。
Apidog Importing Resources from Main Branch

メインブランチから最新の変更をプルする#

スプリントブランチで作業中に、緊急のリクエストによりライブAPIを即座に更新する必要が生じることがあります。その場合、メインブランチで直接変更を行う必要があるかもしれません。これにより、更新されたメインブランチとスプリントブランチの間に不一致が生じる可能性があります。これを解決するために、メインブランチから最新の変更をスプリントブランチにプルして同期することができます。
スプリントブランチに関連付けられたメインブランチのリソースが更新された場合、スプリントブランチでそれらのリソースにアクセスすると明確な通知が表示されます。
resources-discrepancies-notification.png
通知をクリックすると、変更を確認し、メインブランチから更新をプルするか、現在のスプリントブランチを保持するかを選択できます。
decide-change-updates.png
確認後、必要な内容を選択し、更新を確定します。このプロセスにより、スプリントブランチが適切に更新され、メインブランチの更新による競合が解決されます。

新しいリソースを作成する#

現在のスプリントのビジネス要件を満たすために新しいAPI、スキーマ、またはレスポンスコンポーネントを作成する必要がある場合、New機能を使用してこれらの新しいリソースを現在のスプリントブランチに追加します。
Apidog Creating New Resources in Sprint Branch
スプリントブランチでの作成機能は、メインブランチと同じように機能します。スプリントブランチ内の任意のフォルダにリソースを作成できます。新しいリソースに必要な親フォルダがスプリントブランチに存在しない場合は、Select Endpoint FoldersまたはNew Endpoint Folder機能を使用して必要な親フォルダを作成してから、必要なリソースを作成できます。
Select Endpoint Folders: Apidog Select Endpoint Folders
New Endpoint Folder: Apidog New Endpoint Folder

フォルダ内容の並べ替えと調整#

スプリント中に、現在の要件を満たすためにリソースの順序を変更したり、既存または新しいフォルダの内容を変更したりする必要があるかもしれません。スプリントブランチでは、インポートまたは新しく作成されたリソースに対して、メインブランチと同じ操作を実行できます。これには、APIの順序変更や親フォルダ設定の変更が含まれます。フォルダツリー内の項目をドラッグしてAPIの順序を調整し、整理された構造を維持します。
ドラッグによるAPI順序の調整:
Apidog Reordering and Adjusting Folder Contents
インポートされた場合、フォルダにも関連付けを示す表示がされます:
Apidog Reordering and Adjusting Folder Contents
フォルダ内の内容は自由に調整および変更できます:
Apidog Reordering and Adjusting Folder Contents

リソースの削除/復元#

スプリントブランチでは、リソースを自由に削除でき、削除されたリソースはTrashに表示され、復元を選択できます。この機能は、メインブランチのゴミ箱と同じように機能します。
Apidog Deleting/Restoring Resources
スプリントブランチで同じメインブランチリソースを繰り返しインポート、削除、復元すると、予期しないデータ問題が発生する可能性があります。データの整合性を維持し、潜在的な問題を回避するため、可能な限りこれらの操作を最小限に抑えることが最善です。

APIのモック、比較、コラボレーション#

スプリントブランチのAPIには、そのブランチ固有のモックアドレスがあります。モック内容は完全に現在のスプリントブランチ内のAPI定義に依存し、関連するチームメンバーがスプリントの変更されたAPIのレスポンスを正確にシミュレートできます。
Apidog Mocking, Comparing, and Collaborating on APIs
スプリントブランチのリソースをメインブランチの対応するリソースと比較して、特定の違いを特定できます。
Apidog Mocking, Comparing, and Collaborating on APIs
スプリントブランチのAPIは、コラボレーションリンクを介して共有することもでき、他のプロジェクトメンバーに送信してコラボレーションできます。
Apidog Mocking, Comparing, and Collaborating on APIs
別のブランチにいる間にスプリントブランチのAPIコラボレーションリンクをクリックすると、システムはAPIを表示するためにブランチを切り替えるよう促します。切り替える前に、現在のブランチの変更を必ず保存してください。
Apidog Mocking, Comparing, and Collaborating on APIs

OASインポート#

OAS(OpenAPI仕様、Swagger仕様とも呼ばれる)を手動、スケジュール、またはAPIインポートなど、さまざまな方法でスプリントブランチに直接インポートできます。

スプリントブランチにOASをインポートする#

スプリントブランチにOASをインポートするには、左上隅でターゲットブランチが選択されていることを確認し、Project Settings > Import Dataページに移動して、現在のブランチにデータをインポートします。
import-OAS-into-sprint-branch.png
スプリントブランチにOASを自動的にインポートするスケジュールを設定する場合は、スケジュールされたインポートの作成中にターゲットブランチを選択します。
schedule-automatic-OAS-import.png

メインブランチとのOASの自動比較#

スプリントブランチにOASをインポートする際、処理ロジックは次の手順に従います:
OASファイルの内容を識別
OASファイル内の各APIの「Path & Method」をメインブランチのものと比較:
「Path & Method」が一致し、OAS内容がメインブランチと同じ場合、APIはスプリントブランチにインポートされません。
一致する「Path + Method」が見つかり、OAS内容がメインブランチと異なる場合、APIはメインブランチに関連付けられ、スプリントブランチにインポートされます。
一致する「Path + Method」が見つからない場合、スプリントブランチに新しいAPIが作成されます。
OASファイル内のスキーマ名をメインブランチのものと比較:
スキーマ名が一致し、OAS内容が同じ場合、スキーマはスプリントブランチにインポートされません。
一致するスキーマ名が見つかり、OAS内容が異なる場合、スキーマはメインブランチに関連付けられ、スプリントブランチにインポートされます。
一致するスキーマ名が見つからない場合、スプリントブランチにスキーマが作成されます。
インポートが成功すると、スプリントブランチに追加された新しいリソースと変更されたリソースの概要が表示されます。
OAS-import-logic.png
Apidogの目標である、開発者が各スプリントで必要な変更に集中できるようにするため、メインブランチと完全に変わらないリソースはインポート後にスプリントブランチに含まれません。
Previous
ブランチ内でのAPIテスト
Next
スプリントブランチのマージ
Built with