Postmanのコレクションと環境をApidogに移行する

Postmanは全世界の開発者に愛用されているAPI管理ツールになりますが、欠点や使い辛いところもありますね。本文では、より進んでいるAPI管理ツールのApidogを皆さんに紹介します。それに、より効率的にAPIを管理するために、Postmanのコレクションと環境をApidogに移行する方法をここでも入手しましょう。

Postmanとは

Postmanは全世界の開発者に愛用されているAPI管理ソフトです。ただし、Postmanは完璧なソフトではありません。Postmanは日本語をサポートできないし、コレクションランナーにおいて実行制限も設けています。そこで、時としてPostmanより優れていた代替品を探す必要がよくあります。

解説：Postmanとは？日本語化されるのは可能？

本文では、Postman及びその素晴らしい機能を皆さんに紹介した上、日本語に対応済みのAPI管理ソフトのApidogをも皆さんにお勧めしたいと思います。

Apidogブログ - Apiに関する先端知識を取得するshimizu chioka

本文では、Postmanの使用中によく出会った制限を皆さんに紹介した上、これらの制限に対する解決策として、より便利のAPI管理ツールを提案します。

Postmanの欠点

前述のように、Postmanはすごく優秀なAPI管理ツールですが、欠点もいっぱい存在しています。次は、ユーザーによく言われる欠点や制限を皆さんに紹介していみたいと思います。

コレクション実行の制限：APIテスト自動化を実現するために、PostmanのProバージョンを購入したとしても、1ヶ月間でコレクションを250回まで実行できます。この制限は、特に大きなプロジェクトのテスト自動化プロセスに莫大の悪影響を齎しています。

解決済み：Postmanコレクションランナーの制限を解消

Postmanは、コレクションランナーの上限に達すと、「 You have exhausted all the runs. 」エラーが発生します。このエラーは、APIテスト作業の邪魔になっています。本文では、Postmanコレクション制限を無料で解消する対策を皆さんに紹介します。

Apidogブログ - Apiに関する先端知識を取得するshimizu chioka

コラボレーション機能欠如：確かにPostmanを使ってAPIを効率よく管理することができますが、コレクションとの連携がありません。API仕様に変更点がある場合、コレクション中に全てのリクエストやテストを手動で変更する必要があります。これにより、APIテスト自動化のメンテナンスが大変になります。

学習コストが高い：Postmanの利用中に、手動でScriptを書く必要がある場合がよくあります。これは、一般のユーザーにとって不便です。Scriptの再利用性も低いので、繰り返し作業が多くなる可能性が高くなります。

ApidogとPostmanの違い

上記のように、Postmanにはいくつかの欠点がありますので、時として、より優れていた代替品を探す必要があります。そこで、Apidogという次世代のAPI管理ソフトを皆さんにお勧めしたいと思います。

Apidogは、APIの開発においてチームの協同作業のために開発されていて、APIの設計、開発、テスト、管理、ドキュメント生成やAPI Mockなどのことが実現され、今までにない包括的なAPIツールです。Apidogには、Postmanの機能だけではなく、Swagger、Stoplight、Jmeterの機能も全てあります。Apidogを使用すると、APIドキュメント（定義書）が簡単に作成されます。

そして、この定義書に基づき、バックエンド開発者はAPIを簡単に実装して自己テストを行い、フロントエンド開発者はAPIを簡単に呼び出してデータのモッキングを行って、テストエンジニアはAPIを直接にテストしてテストケースを簡単に生成できるので、個人作業の効率をも大幅に向上していますし、チームメンバー間のコラボレーションの効率をもかなり上げています。

コレクション、APIケース、とテストシナリオ

ApidogとPostmanでは、APIのデバッグか単体テストのプロセスが違っています。

Postmanでは、リクエストを中心に処理が行われます。つまり、リクエストを作成し、コレクション内に入れて実行するという流れになります。その一方で、Apidogはコレクションという概念がなく、全てのリクエストを別々のAPI内で含まれます。そこで、Apidogでは、リクエストがAPIごとに整理され、より直感で探しやすくなるのでしょう。

PostmanからApidogに移行すると、PostmanのリクエストはApidogのAPICaseに変換され、Pre Request ScriptやテストもこのAPICaseに含まれます。これにより、APIの各リクエストをより適切に管理することができます。

ApidogでPostmanのコレクション実行のような操作をするには、自動テストモジュールを使用する必要があります。そこで保存済みのAPICaseを参照して、テストシナリオを作成して、リクエストを一括実行することができます。実行すると、Postmanと同じようなレポートを生成することもできます。

このアプローチのメリット：

まず、APICaseを保存すると、それを複数のテストシナリオに入れることもできるので、リクエストの重複作成を避けることができます。

次に、APIの定義を変更しても、その変更はAPIケースとテストシナリオの両方にも自動的に反映されるので、API仕様書が何回も変更されるとしても、手動でテストシナリオなどを変更する必要がありません。これにより、チームのコラボレーション上の課題も完璧に解決できます。

さらに、Apidogは、テストシナリオ内で条件分岐とか、ループ回数などの機能にも対応しています。この機能により、直感的な操作によってAPICaseを参照したり、テストシナリオを配置したりできる柔軟なAPIテストそシューションを提供できますね。

環境とサービス

多くの組織では複数の環境を持っており、PostmanではURLの先頭に環境変数を置くことで環境の切り替えを実現しています。しかし、このアプローチは十分に便利とは言えません。リクエストのURLとAPIエンドポイントのURLが違うようになりますし、環境と変数の設定も混在してしまいます。

その一方、Apidogでは、プレフィックスURLに相当するものを「サービス」と呼び、APIかフォルダ別にこのサービスを設定できます。さらに、環境別で同じなサービスにも異なる値を設定することもできますので、環境間のシームレスな切り替えが可能です。

さらに、Apidogの環境には複数のサービスを含めることができます。あるAPIはuser.xxx.comにリクエストし、別のAPIはorder.xxx.comにリクエストする、といった場合でも利用できます。各環境にサービスのセットを構成することで、対応するプレフィックスURLとともにAPIエンドポイントを簡単に整理して実行できます。

この機能をベースに、Apidogはローカルモックサーバーとクラウドモックサーバーも内蔵されています。これらのモックサーバーを利用することで、別途モックサーバのセットアップが不要になります。 モックサーバーにリクエストを送信すると、API定義に定義されたレスポンスに基づき、現実的なレスポンスデータが返されます。 これにより、フロントエンド開発者はAPI開発完了前でも、インターフェイス開発のために手軽にモック環境を利用できるのです。

Scriptと前・後処理

Postmanでは、プリリクエストとテストの両方にScriptを記述する必要がありますので、QAエンジニアにとっては非常に不便です。しかし、Apidogでは直感的な前・後処理機能を提供されるので、誰でも簡単に始めることができます。

まず、ApidogはPostmanのScriptを直接使うことをサポートしています。「カスタムScript」セクションで直接実行したり、「共通Script」セクションで参照したりすることができます。

そのうえで、Apidogには次のようなユーザーフレンドリーな視覚的な前・後処理機能が用意されています。

レスポンスの検証: JsonPath表記を使ってレスポンスから任意の要素を取得し、アサーションを実行できます。

変数の抽出: レスポンスから値を変数として抽出できます。

データ変換: リクエスト/レスポンスデータの変換ができます。

環境切り替え: テスト実行時の対象環境を切り替えられます。

データベース操作: テストの前後でデータベースを操作できます。

これらのプロセッサを視覚的に設定することで、コードを書くことなく必要な処理が実現できます。

PostmanをApidogにシームレスに移行する

コレクションの移行

まず、Postmanのコレクションをエクスポートする必要があります。コレクションをエクスポートすると、APIクエリと結果を他の人と共有したり、他のプログラムで使用したりすることもできるようになります。

以下に示すように、Postmanでエクスポートしたいコレクションを選択し、「Export」をクリックします。

「Collection v2.1」フォーマットでエクスポートすると、すべてのクエリ、ディレクトリ、および詳細もエクポートできます。したがって、2番目の「Collection 2.1　Recommended」を選択しましょう。

上記の操作ガイドを参照して、Postmanのデータを成功にエクスポートした後、次のステップに従えば、簡単にApidogにインポートすることができます。

ステップ⒈Apidogのプロジェクトを開くと、左側のメニューで「設定」をクリックします。

ステップ⒉「データをインポート」をクリックして、「Postman」を選択します。

ステップ⒊画面下部のファイルアップロードのエリアをクリックして、Postmanのファイルを選択するか、ファイルをそのエリアにドラッグ＆ドロップすることで、データをインポートします。

ここでPostmanのデータを成功にApidogにインポートしたはずです。

環境の移行

コレクションの移行と同じように、Postmanの環境をApidogに移行するには、まずは環境をエクスポートする必要があります。Postmanでコレクションと環境は別の場所に保存されているので、Postmanで環境の左の「...」をクリックして、「Export」を選択することで、Postmanの環境をエクスポートします。

Postmanの環境のエクスポートに成功すると、次の操作を参照して、それを簡単にApidogにインポートすることができます。

まずは、Apidogを開き、右上コーナーにある環境管理をクリックして、環境管理のウィンドウを開く必要があります。ここで環境の左側に「...」が見えるので、そこをクリックして、「インポート（Postmanフォーマット）」を選択します。

そして、先にエクスポートしたPostman環境のデータファイルを選択すると、Postmanの環境をすぐにApidogにインポートすることができます。

まとめ

Apidogは機能面と使い勝手の両方でPostmanを上回っており、API開発チームのワークフローを合理化したい場合には最適な選択だと言えます。また、本文で紹介したように、Apidogは、Postmanからのスムーズな移行プロセスを提供しています。

• PostmanのScriptとの互換性あり
• 簡単なインポート機能でPostmanデータをシームレスに移行可能

Apidogは、優れた機能と直感的なUIにより、Scriptに不慣れなメンバーでも効率的に参画できるようにしています。