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. 移行

データのエクスポート

ApidogはOpenAPI仕様、HTML、Markdown、Apidogなどのデータ形式でのAPIのエクスポートに対応している。

データのエクスポート#

左メニューバーの「設定」→「データのエクスポート」を選択し、希望するデータ形式を選んで「エクスポート」ボタンをクリックする。
すべてのAPIを一括でエクスポートすることも、特定のAPIを選択してエクスポートすることもできる。
タグでグループ化されたAPIを対象としたエクスポートも可能だ。
OpenAPI仕様 については、バージョン3.1、3.0、Swagger 2.0 に対応している。YAMLまたはJSON形式でエクスポートでき、Apidog拡張OpenAPIフィールドを含め、Tagsフィールドをフォルダとして使用したエクスポートが可能だ。
また、オフラインドキュメントとしてデータをエクスポートすることも可能だ。「URLを開く」をクリックすると、ブラウザで直接RAWコンテンツにアクセスして閲覧できる。

スプリントブランチからのエクスポート#

ページ左上に表示されているブランチをエクスポート対象として選択することで、スプリントブランチからデータをエクスポートできる。スプリントブランチからエクスポートする場合、そのブランチのすべてのデータをエクスポートする必要がある。
エクスポートプロセスでは、データの完全性を確保するため、現在のスプリントブランチとメインブランチをマージする。この手順は重要で、Apidogの様々なデータ項目は参照を通じて相互に接続されているため、スプリントブランチの表示内容だけをエクスポートすると、不完全または使用できないデータになる可能性がある。
export-data-from-a-sprint-branch.png
スプリントブランチからデータをエクスポートする場合、特定の一部分を選択することはできない。エクスポートには、スプリントブランチとメインブランチの間でマージされたすべてのコンテンツが自動的に含まれる。

OperationID#

OperationIdは、OpenAPI仕様でAPI操作を一意に識別するために使用される識別子だ。OpenAPI形式でエクスポートする際、OperationId 属性を設定でき、この識別子がエクスポートされたOperation オブジェクトのOperationIdに含まれる。

OAS (OpenAPI Specification) のカスタムエクスポート設定#

1
移動先: プロジェクト概要 > API仕様 > 設定/追加
CleanShot 2025-03-31 at
11.29.31@2x.png
2
表示されたインターフェースでカスタムエクスポートパラメータを設定する。
CleanShot 2025-03-31 at
11.32.37@2x.png

FAQ#

Q: エクスポートされたAPIの数が減ってしまうのはなぜ?
A: 複数のAPIが同じメソッドとパスを使用している場合に発生することがある。HTMLとMarkdownはOpenAPIデータ変換を介してエクスポートされるが、この方式では複数のAPIが同じメソッドとパスを共有することをサポートしていない。
Q: MarkdownとHTMLにエクスポートした際、APIの順序が乱れるのはなぜ?
A: OpenAPIの一部であるSwagger仕様には、APIの順序付けやグループ化を明示的にサポートする機能がない。そのため、MarkdownとHTMLへのエクスポートでは整理されていない状態で表示されることがある。整理された状態でエクスポートしたい場合は、Apidogのネイティブ形式の使用を検討するといい。
Q: 複数のAPIが同じURLを持つ場合、エクスポートされるAPIの数が減るのはなぜ?
A: OpenAPI仕様では、複数のAPIが同じメソッドとパスを共有することを許可していない。各APIには固有のURLを使用するようにする必要がある。APIの一意識別子の確保について詳しくは、APIの一意識別を参照。HTMLとMarkdownのエクスポートは両方ともOpenAPIを介して行われるため、同じ制限が適用される。
Q: PDFにエクスポートするにはどうすればいい?
A: 現在、ApidogではPDFやWordへの直接エクスポートはサポートされていない。ただし、まずMarkdown形式でデータをエクスポートし、その後で外部ツールを使用して希望の形式に変換することができる。例えば、Typoraを使用すると、MarkdownをPDF、Word、OpenOffice、Epubなどの形式に変換できる。
Q: 複数のAPIのうち1つしかエクスポートされなかったのはなぜ?
A:
1.
複数のAPIが同じメソッドとパスを使用していないか確認する
2.
OpenAPI仕様では、異なるAPIが同じメソッドとパスの設定を共有することを禁止している。詳しくはAPIの一意識別 を参照
3.
OpenAPIデータを介してHTMLやMarkdownに変換する際に問題が発生する可能性があることに注意
Q: 認証値をエクスポートするには?
A: Apidogは Auth 値をSwagger形式のファイル内に自動的にエクスポートする。追加の設定は必要ない。これらの値を確認するには、Swagger形式ファイルの securitySchemes セクションを確認する。
Previous
インポートオプション
Next
Postman からインポート
Built with