ご存じですか？PostmanとApidogでのSwagger APIインポート完全ガイド

## 初めに
Swaggerは、API仕様書を自動生成するためによく利用されるオープンソースフレームワークです。Swaggerフレームワークで記述しているAPIを[Postman](http://apidog.com/jp/blog/what-is-postman-and-its-japanese-setting/)にインポートして、テストの効率化を図るのはごく一般的なことになります。

この記事では、Swaggerで記述したAPI定義をPostmanにインポートし、それを元にテストを作成する方法を紹介しました。また、Swagger APIのインポートに対応し、Postmanの欠点を改善する新世代ツール「Apidog」も推奨しています。

## Swagger仕様のAPIとPostman
[Swagger](http://apidog.com/jp/blog/swagger-definition-and-its-japanese-setting/)はAPI設計書を自動生成するためのオープンソースフレームワークで、Swagger Spec(OpenAPI Specification)は、Swaggerが使用するAPI記述言語の仕様です。Swagger仕様は、YAMLやJSON形式でAPIの構造を定義するための標準的な方法を提供します。現在、Swagger仕様に準拠した形式で記述されたAPIはすでに主流になっています。

SwaggerはAPIのドキュメント化に強みがある一方、PostmanはAPIのテストと検証に強みがあります。両者を組み合わせることで、ドキュメント作成とテストを効率的に行えます。そこで、APIのテストと検証の効率化を図るために、Swagger仕様のAPIをPostmanにインポートすることが多く見られています。

## SwaggerのAPIをPostmanにインポートする方法
SwaggerのAPIをPostmanにインポートするために、通常2つの方法によって実現できます。SwaggerドキュメントのURLからインポートすることもできますし、Swagger Specファイルからインポートすることもできます。次は、この2つの方法を1つずつ紹介します。

### URL経由でSwaggerのAPIをPostmanにインポート
**ステップ⒈**SwaggerのAPIのページを開きます。通常API名の下にドキュメントのURLが記載されています。そのURLをコピーします。

![swagger-petstore-1.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/2a7b0bed-9884-8645-b4f8-e31d16027603.jpeg)

**ステップ⒉**Postmanを開き、画面の左上にある「Import」ボタンをクリックします。

![import-2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/ac14dffc-25b0-e7d1-87a4-c92110048dad.png)

**ステップ⒊**Postmanの入力ボックスに先にコピーしたURLを貼り付けると、インポートのプロセスが開始されます。

![select-postman-file-3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/b2022c7e-c6e6-eef0-7c55-5e9a8afc5c72.png)

**ステップ⒋**インポート方式を選択して、「**Import**」ボタンをクリックすると、SwaggerのAPIをPostmanにインポートできます。

![import-swagger-api-4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/177b6f58-480f-514b-9b29-0ee463d45166.png)

**ステップ⒌**インポートプロセスが完了すると、Postmanの左側のメニューからインポートできたAPIを確認できるようになります

![import-complete-5.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/398651ca-8475-1f1a-c74b-4d9f56939c5f.png)

### Swagger Specファイル経由でAPIをPostmanにインポート
SwaggerドキュメントのURLを使って、APIを簡単にPostmanにインポートできますが、Swagger Specファイル（JSONかYAMLフォーマット）を使っても、APIをPostmanにインポートすることもできます。

**ステップ⒈**SwaggerドキュメントのURLを開くと、JSONデータを取得することができます。

![swagger-petstore-1.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/a3941c9d-9df4-22b6-ad2d-20e54a8aafb1.jpeg)

**ステップ⒉**パソコンで空のJSONファイルを作成して、ページ上のJSONデータを丸ごとファイルにコピーします。

**ステップ⒊**Postmanを開き、「**Import**」ボタンをクリックし、インポートエリアにJSONファイルをドラッグ＆ドロップすることで、APIをPostmanにインポートできます。

![select-postman-file-6.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/8deea11d-c1d4-1674-b8a8-d5865e59f36a.png)

## Apidog：より使いやすくSwagger互換のAPIクライアント

[Apidog](http://www.apidog.com/jp/?utm_source=opr&utm_medium=a2takuya)はOpenAPI（Swagger）の仕様を完璧にサポートしています。そこで、 Swagger仕様のAPIをインポートして、より効率的にテストしたり、より綺麗なAPIドキュメントを生成したりすることを実現したい場合は、それを直接にApidogにインポートして、シームレスに作業を進むことができるのでしょう。
また、ApidogはSwaggerからの自動インポートにも対応できます。つまり、Swagger側でAPI仕様に何か変更がある場合でも、それが自動的にApidogで反映されます。

![apidog-1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/3049145e-85b8-b757-2c47-f1e2be6c1c5b.png)

## ApidogはPostmanより便利にAPIをテスト可能
Postmanには実行制限や環境切り替えの問題などの課題がある一方、[Apidog](http://www.apidog.com/jp/?utm_source=opr&utm_medium=a2takuya)は日本語にも対応可能な新世代のAPI管理ツールだと捉えています。Apidogは、APIの設計、仕様書生成と共有、APIモック、APIテストなどの機能も完備しています。また、ApidogはAPI定義との連携、視覚的なテスト作成、環境とサービスの分離など、Postmanの欠点を多数改善しています。

詳しくは：[Apidogとpostmanの違い｜どちらにしようかを完全解説](https://apidog.com/jp/compare/apidog-vs-postman/)

![apidog-2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3877124/519d8daa-1557-5aa1-4170-d9613a78e49b.png)

APIの開発効率を向上させたい場合でも、APIの品質を上げたい場合でも、[Apidog](http://www.apidog.com/jp/?utm_source=opr&utm_medium=a2takuya)を利用するのがおすすめです。

## 終わりに
**今回は以上になります！
最後まで見ていただきありがとうございました！
この記事を読んで少しでも理解を深めていただければ幸いです！**