Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Apidogへの移行
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidogのナビゲーション
    • Apidogの基本概念
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストの送信とAPI保存
    • Apidogへの移行
      • 概要
      • 手動インポート
      • 定期インポート(データソース連携)
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • APIの構成方法
    • エンドポイントの基本
    • API設計規範
    • モジュール
    • 複数のリクエストボディ例の設定
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • コメント機能
    • 一括API管理
    • カスタムプロトコルAPI
    • データモデル
      • 概要
      • 新規Schemaの作成
      • JSONなどからのSchema生成
      • スキーマを構築する
      • oneOf / allOf / anyOfの使い方
      • 識別器(Discriminator)の利用方法
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • 関連テストシナリオ
      • パラメータリストの表示形式
      • 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ケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • 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を編集
    • エンドポイント適合性チェック
    • APIドキュメント完全性チェック
    • AI命名
    • よくある質問
  • 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 Schema
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Apidogへの移行

インポートオプション

手動インポート と定期インポートの両方で、以下のような一連のインポートオプションがある:
CleanShot 2025-11-24 at
11.48.39@2x.png

基本認証#

URLを使用してインポートする場合、一部のURLは基本認証による暗号化を使用している場合がある。この場合、基本認証のトグルをオンにして、ユーザー名とパスワードを入力するだけでよい。

インポート対象の設定#

対象ブランチ#

データを取り込む作業ブランチを選択します。通常は「main」ブランチが既定です。

取り込み先#

新規のAPIや各種データを、プロジェクト内の既存モジュールへ追加するか、新規モジュールを作成して格納するかを選べます。

APIとケースの設定#

APIケースを自動生成#

取り込むAPIドキュメントに具体的なテストケースが含まれていない場合、このオプションを有効にすると、Apidogが各APIに既定の「Success」ケースを自動生成し、すぐにテストを開始できます。

OpenAPI/SwaggerのServersを環境として取り込む#

取り込むOpenAPI/Swagger仕様書に複数のサーバーアドレスが定義されている場合、このオプションを有効にすると、プロジェクト内にそれぞれを別環境として自動作成し、テスト対象の切り替えが容易になります。
image.png

セキュリティと認証の取り扱い#

セキュリティスキーム(Security Scheme)は、OpenAPIなどのAPIドキュメントで、APIの認可方法を記述するための設定です。
クライアントがAPIへアクセスする際に、トークン、API Key、OAuth2による認可など、どのように認証情報を付与するかを示します。

セキュリティスキームの取り込み#

この設定を有効にすると、資料で定義された各種セキュリティ設定(API Key、Basic認証など)がApidogの認証設定に取り込まれます。
「Root」フォルダーの認証として、OpenAPI仕様書で定義されたグローバルなセキュリティスキームを採用できます。
セキュリティが未定義のAPIについては、取り扱い方針を指定できます(例:親フォルダーのAuthを継承/認証なしに設定)。
image.png

命名規則とサマリー#

APIのサマリーが未入力の場合#

取り込んだAPIに明確な名称(「Summary」)がない場合、Apidogは既定で「operationId」の値をAPI名として用います。パスを用いる、または説明文から名称を抽出することも選択できます。
image.png

リソースの競合処理#

取り込むデータが、プロジェクト内の既存APIやデータモデル、コンポーネントと重複する場合の扱いを選択します。

APIの競合#

同一API(メソッドとパスで判定)が見つかった場合の挙動:
上書き:新規に取り込むAPIで既存の内容を完全に置き換えます。
両方保持:両方のAPIをプロジェクト内に残します。
無視:競合した新規APIの取り込みを行いません。
マージ:既存API側の変更済み名称、モックルール、パラメーター説明、レスポンス例を保持します。
選択項目のみ上書き:選択したフィールドだけを上書きし、未選択の項目は現状を維持します。
image.png

Markdown、データモデル、コンポーネント#

Markdownファイル、データモデル、コンポーネントの競合についても同様に、「上書き」や「マージ」などの選択肢がドロップダウンで利用できます。
image.png

フォルダーの同期#

同一APIが異なるフォルダーにある場合:
取り込んだAPIが既存のAPIと一致する一方で、新旧ファイル間でフォルダー情報(フォルダー名、前/後処理 など)が異なる場合、以下から選べます。
既存APIのフォルダーを維持:新ファイル側のフォルダー情報は無視し、プロジェクトの元のフォルダー設定を保持します。
APIのフォルダーを更新:新ファイルのフォルダー情報で、プロジェクト内の所属フォルダーを更新します。
image.png

リソースのクリーンアップ#

Apidogは、新規に取り込むファイルとプロジェクト内の既存リソースを比較します。
削除しない:新ファイルに存在しない既存リソースは残します(安全策)。
削除する:新ファイルに存在しない既存リソースを削除します(同期策。取り込み元データと完全に整合させます)。
image.png
Modified at 2025-11-25 10:47:01
Previous
定期インポート(データソース連携)
Next
データのエクスポート
Built with