メインコンテンツまでスキップ

OpenAPI (Swagger) データのインポート

Apidogは、JsonまたはYAMLドキュメントのOpenAPI 3.1Swagger 1、2、3データ形式のインポートをサポートしています。

手動でインポート

プロジェクトの設定を開き、データをインポート(手動)をクリックして、ファイルURLから手動でインポートできます。

手動インポート - ファイルのインポート

JSONまたはYAMLファイルを下図に示すエリアにドラッグアンドドロップするか、そのエリアをクリックしてファイルを選択してインポートします。

apidoc

手動インポート - URLのインポート

ご案内:

URLのインポートを使用する場合は、Swagger UIのURLではなく、JSONまたはYAMLファイルのURLを提供する必要があります。

adada

インポート - 詳細設定

OpenAPI/Swagger 形式のインポートには、API、Schema、および環境のみが含まれます。

既存のAPIを上書き

同じURLの上書き:2つのファイルが同じURLと通信方式を持つ場合、新しいファイルは古いファイルを上書きします。

URLとディレクトリが同じ場合にのみ上書き: 2つのファイルが同じURLと通信方式を持ち、それらが同じディレクトリにある場合、新しいファイルは古いファイルを上書きします。

インポートしない:2つのファイルが同じURLと通信方式を持つ場合、新しいファイルはインポートされません。

両方を保持:2つのファイルが同じURLと通信方式を持つ場合、新しいファイルもインポートされ、古いファイルも削除されません。

apidog

  1. ディレクトリにインポート:ファイルを特定のディレクトリにインポートすることをサポートしています。

APIテストケースをインポート:スイッチオンすると、選択したAPIの下にあるすべてのユースケースがデフォルトで選択され、対応するAPIのテストケースもインポートのプレビューで選択できます。

apidog

ヒント: Apidog 以外の形式でファイルをインポートし、APIドキュメントが上書きされた場合、同じ名前のAPIのテストケースはインポートされませんが、異なる名前のテストケースのみが追加されます。

画像に示すように、上書きモードを選択してディレクトリにインポートするために、Schemaを個別に設定する必要があります。

バージョン2.2.18から、「ディレクトリに更新を同期する」の新機能が追加されました。ApidogのAPIキュメントを更新して、それをSwaggerのフォルダとディレクトリに更新を同期したい場合は、「ディレクトリに更新を同期する」のスイッチをオンにすることができます。

自動インポート

プロジェクト設定を開き、データを自動インポートをクリックして、複数のデータソースを設定し、定期的に特定のディレクトリに同期できます。

ご案内:

プロジェクトの管理者のみがソフトを開くときに、自動インポートが設定の頻度に応じてインポートされます。

他のメンバーは、自動インポートを行いません。

apidog

ご案内:

URLのインポートを使用する場合は、Swagger UIのURLではなく、JSONまたはYAMLファイルのURLを提供する必要があります。

adada

スマートマージ

ほとんどのユーザーは、OpenAPI(Swagger)データをApidogにインポートし、名前、Mockルール、パラメータの説明を追加し、Schemaの例を返します。バックエンド開発者はSwaggerでAPIを設計しても、他のチームメンバーはApidogでAPIを管理、デバッグ、テストできます。

上記のシナリオを満たし、自動/手動インポートがデータソース内のすべてのフィールドを完全に上書きする状況を回避するために、Apidogはバージョン2.2.27-alpha.1に「スマートマージ」機能を追加しました。

OpenAPI(Swagger)データをインポートする準備ができたら、「同じAPIをマッチする場合」で「スマートマージ」を選択すると、名前、Mockルール、パラメータの説明、およびApidogで変更されたSchemaの例が保持されます。

apidog