API開発中にPostmanはよく使われるツールになります。Postmanのデスクトップアプリとは別に、Postmanは2020年よりブラウザバージョンも提供し始めていました。これにより、ユーザーはアプリケーションをパソコンにインストールする必要がなくなり、ブラウザでPostmanオンラインが使えるようになりました。
それでは、どうやってPostmanオンライン(Postmanのブラウザバージョン)を利用すればいいですか?本文では、初心者でも分かるPostmanオンラインバージョンの利用ガイドを皆さんに紹介します。
Postman Webアプリとは
Postman Webアプリは、Postman Webバージョン、Postmanブラウザアプリ、Postman オンラインとも言われています。次の文では、これらの用語を混用する場合があります。
Postman Webアプリは、Postmanのオンライン版です。通常のPostmanはデスクトップアプリケーションとして提供されており、開発者がAPIをテスト、デバッグ、ドキュメント化するために使用できます。しかし、Postman Webバージョンはブラウザ上で動作し、デスクトップアプリケーションをインストールする必要がなくなります。Postman Webバージョンを使用すると、開発者はブラウザを介してAPIをテストおよび管理できます。Webバージョンでは、Postmanの基本機能や機能拡張、コレクションの作成や共有、環境の管理など、デスクトップアプリケーションと同様の機能が利用できます。
Postmanのブラウザアプリのメリットとデメリット
Postmanオンライン、つまりそのブラウザアプリは、通常のデスクトップ版に比べると、メリットとデメリット両方もあると考えられています。
Postman Webバージョンのメリット
Postman Webバージョンのメリットといえば、複数のデバイスや場所からアクセスできることにあると思います。デスクトップアプリケーションを使用する場合、個々のデバイスにアプリケーションをインストールする必要がありますが、Webバージョンではブラウザを通じてどのデバイスからでもアクセスできます。
Postma Webバージョンのデメリット
Postman Webバージョンには、いくつかのデメリットがあります。以下にいくつかの一般的なデメリットを挙げます。
- オフラインでの使用制限: Postman Webバージョンは、インターネットに接続された状態でのみ使用できます。オフライン環境での使用や、低速なインターネット接続がある場合には制約があります。
- ローカルファイルへの制限: Postman Webバージョンでは、ローカルマシン上のファイルに直接アクセスすることが制限されています。デスクトップアプリケーション版では、ファイルのインポートやエクスポート、ファイルの参照などが容易に行えますが、Webバージョンではこのような操作に制約があります。
- 高度な設定オプションの制約: Postmanのデスクトップアプリケーション版には、高度な設定オプションや機能拡張が利用できますが、Webバージョンでは一部の機能が制限される場合があります。特定の要件や複雑なテストシナリオに対応するためのカスタマイズや拡張機能を利用する場合には、デスクトップアプリケーション版の方が適しているかもしれません。
- セキュリティの制約: Webバージョンでは、データや認証情報がオンライン上で処理されるため、デスクトップアプリケーション版に比べてセキュリティ上の懸念が存在する可能性があります。ただし、Postmanはセキュリティに重点を置いており、適切なセキュリティ対策を実施していますが、Web上でのデータ処理には注意が必要です。
完全解説:Postman Webアプリの利用ガイド
この部分では、Postmanのブラウザアプリを使って、新しいリクエストを作成したり、コレクションを作成したりする方法を皆さんに紹介します。
Postmanのブラウザアプリで新しいリクエストを作成する
Postmanオンラインにログイン
Postmanのブラウザアプリを利用するには、まずはPostmanの公式サイトでアカウントにログインする必要があります。アカウントをお持ちでない場合、「Sign Up for Free」ボタンをクリックして、アカウントを新規作成する必要があります。
新しいリクエストを作成
Postman Webバージョンの操作画面で、「New」をクリックして、APIのメソッド(GET, POST, PUT, DELETなど)を選択して、リクエストを新規に作成します。
エンドポイントのURLとパラメータを記入
APIのエンドポイントのUrlを入力し、必要に応じて、パラメータかヘッダーをも記入します。
リクエストを送信
要求された情報を全て記入すると、「Send」ボタンをクリックして、リクエストを送信できます。
レスポンスを確認
Postmanは、ここでリクエストを先に記入したエンドポイントに送信して、そこからレスポンスを取得します。このレスポンスには、ステータスコード、ヘッダー、ボディなどの情報が含まれます。
Postman Webバージョンでコレクションを作成する方法
コレクションは、APIのリクエストをグループ化にするものです。APIテスト自動化を実現するのに便利です。そこで、Postmanの利用頻度が高い機能といえば、コレクションは必ずその1つになります。そこで、次は、Postman Webバージョンでコレクションを作成する操作手順を紹介します。
ステップ⒈画面の左上隅にある「New」ボタンをクリックして、表示される「Collection」を選択します。
ステップ⒉コレクションの名前を設定して、「Create」ボタンをクリックして作成します。
ステップ⒊画面の左上にある「Import」ボタンをクリックして既存のコレクションファイルからリクエストを導入することもできます。
ステップ⒋「Add Request」をクリックして、コレクション内のリクエストを手動で選択して追加することも可能です。
ここで、コレクションを成功に作成できました。コレクションを作成すると、Postmanは、追加済みのリクエストを順番に自動送信することができるようになりますので、非常に便利なツールになります。
Postman Webアプリの代替:Apidogの日本語化Webアプリ
Apidogは、APIライフサイクル管理を支援するAPI管理ツールとして、デスクトップと同じ機能を提供するWebバージョンがあります。そして、Apidogは、日本語化されているツールなので、国内のユーザーは、Postmanの英語UIに苦しむことなく効率的に利用できます。
Apidog Webアプリの主な機能
- APIの設計と仕様書生成:ApidogのAPIドキュメントは、 OpenApi 3.0 (以前はSwagger) と JSON Schema の使用に準拠し、 便利なビジュアルドキュメント管理機能を提供します。これは、開発者にとって0学習コストを意味します。また、APIドキュメントのオンライン共有もサポートしています。
- データモデルの利用(Schema): Apidogは再利用可能なデータ構造をサポートしています。また、直接ネストされたモデルの参照、直接JSON/XMLのスマートインポートをサポートし、oneOf、allOfなどの高度な組み合わせパターンをサポートします。
- APIのデバッグ: 環境変数、前/後処理Script、Cookie /セッションのグローバル共有など、Postmanが持っている機能を全部備えています。それに、Apidogは、より使いやすくて効率性が高くなります。APIを実行した後、
APICaseを保存
ボタンをクリックしてAPIケース
を作成すると、この後はパラメータを再入力せずに当該APIを直接に実行できるので、非常に便利です。カスタムScriptはPostmanの構文に互換し、javascript、java、python、PHP、js、BeanShell、go、shell、ruby、luaやその他のプログラミング言語での実行コードを全面的にサポートしています。 - APIのユースケース:APIには通常、多数のユースケース(パラメータのユースケースが正しいか、正しくないか、空であるか、パラメータの状態が異なるなど)があります。ApidogのAPIケース機能は、ユースケースを実行するときに、データの正確性の確認が自動的に開始されるので、デバッグすることは非常に効率的です。
- APIデータのモッキング:Apidogには、統合されたMock.jsルールエンジンが含まれているので、非常に簡単に様々なデータをMockし出すことが可能です。開発者は、データ構造をする同時に、Mockのルールを定義できます。そして、「期待」を追加して、Requestパラメータに基づいて複数のMockデータを返すことをもサポートしています。また、最も重要な特徴は、
設定必要なし
で現実的なデータをシミュレートすることです。関連するセクションに関して、後でより多くの情報を紹介します。 - データベース操作:Apidogは、データベースデータの読み取ってそれをAPIのRequestパラメータとして使用することをサポートしています。Apidogは、データベースのデータを読み取って、APIのRequestが成功したかどうかを認証することもできます。
- コレクション対応とAPIテスト自動化:ApidogはAPIコレクションテストをサポートしているため、開発者はAPI(またはAPIユースケース)を選択してテストコレクションをすばやく作成できます。APIの自動テストに関するより多くの機能はまだ開発中ですが、お楽しみください!開発者のエクスペリエンスを向上させながら、JMeterのすべての機能を備えることがこちらの目標です。
- コード生成:API及びデータモデルの定義に基づいて、システムは自動的に
API requestコード
,フロントエンドコード
とバックエンドコード
を生成します。 - チームの協業: Apidogはチームのコラボレーションのために設計されています。APIの更新がリアルタイムにクラウドで同期され、
チーム/プロジェクト/メンバー権限
の管理に対応しています。 Apidogは、異なるビジネスモデルのニーズを満たすように努力しています。