Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Import from...
  • 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. Import from...

OpenAPI(Swagger)仕様のインポート

Apidog は、OpenAPI 3.0、OpenAPI 3.1、Swagger 2.0 のデータ形式に準拠した JSON または YAML ファイルのインポートに対応しています。
Apidog は OpenAPI/Swagger の仕様拡張(Specification Extensions)の取り込みにも対応しています。Apidog がサポートする API フィールドは、こちらのドキュメントをご参照ください。
手動インポートおよび定期インポートでは、以下のとおり一連のインポート設定を行います。
CleanShot 2025-11-24 at 11.48.39@2x.png

インポート対象の設定#

対象ブランチ#

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

インポート先#

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

API とケースの設定#

API ケースの自動生成#

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

OpenAPI/Swaggerのサーバーを環境として取り込む#

インポートするドキュメントに複数のサーバーアドレスが定義されている場合、このオプションを有効にすると、各アドレスをプロジェクト内の別々の環境として自動作成し、テスト対象の切り替えを容易にします。
image.png

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

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

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

この設定を有効にすると、ドキュメントで定義された各種セキュリティ設定(API Key、Basic Auth など)を Apidog の Auth 設定として取り込みます。
・「Root」フォルダーの Auth を、OpenAPI仕様 で定義されたグローバルなセキュリティスキームとして設定することができます。
・セキュリティ未定義の API をどのように扱うかも指定できます(例:親フォルダーの Auth 設定を継承、または「認証なし」に設定)。
image.png

命名規則とサマリー#

API の Summary フィールドが空の場合#

取り込んだ API に明確な名称(Summary)がない場合、Apidog は既定で operationId を API 名として使用します。パス名の使用や、説明文からの抽出に切り替えることも可能です。
image.png

リソースの競合処理#

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

API の競合#

同一の API(Method と Path が一致)を照合した際の動作:
・上書き:新しく取り込んだ API で旧 API の内容を完全に置き換えます。
・両方を保持:両方の API をプロジェクト内に残します。
・無視:新しく取り込む側の競合 API を無視します。
・マージ:旧 API 側で変更した名称、モックルール、パラメーター説明、レスポンス例を保持します。
・選択フィールドのみ上書き:選択したフィールドだけを上書きし、未選択のフィールドは既存内容を維持します。
image.png

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

Markdown、データモデル、コンポーネント の競合についても、「上書き」や「マージ」など同様のプルダウンオプションを利用できます。
image.png

フォルダー同期#

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

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

Apidog は、新しく取り込むファイルとプロジェクト内の既存リソースを比較します。
・削除しない:新しいファイルに存在しない既存リソースもそのまま保持します(安全な選択)。
・削除する:新しいファイルに存在しない既存リソースを削除します(同期の選択。取り込み元データとの完全一致を保証)。
image.png

URL インポート#

URL でインポートする場合は、Swagger UI のベース URL ではなく、JSON または YAML のデータファイルに直接アクセスできる URL を指定してください。
image.png
URL でのインポート時、一部の URL は Basic 認証で保護されている場合があります。その際は、Basic 認証のトグルをオンにして、ユーザー名とパスワードを入力してください。

定期インポート#

「設定」パネルを開き、「データのインポート」に移動し、「スケジュール」をクリックする。ここで複数のデータソースを選択し、定期的に特定のフォルダに同期できる。
TIP
データのインポート オプションは、プロジェクト管理者のみが表示・アクセスできる。
automatic-import.png

Modified at 2025-11-25 11:10:10
Previous
Postman からインポート
Next
cURLのインポート
Built with