Postmanを使ったAPIのデバッグ方法

Postmanは、リモートAPIサービスの作業、開発、デバッグを容易にするためのプログラムおよびツールキットです。GETおよびPOSTリクエストの作成、管理、作業のためのプラットフォームを提供します。

ポストマンとは何ですか？

Postmanは自らを「API開発のためのプラットフォーム」と説明しています。基本的なレベルでは、リモートAPIと対話するためのシンプルなGUIインターフェースを提供しています。これは本質的に、複雑なAPIと作業するために設計された最先端のRESTクライアントです。

優れたRESTクライアントであるだけでなく、リクエストのコレクションを管理するためのツールも備えています。これらのコレクションを利用し、APIスキーマの知識を活用することで、完全に自動化されたAPIテストを実行でき、CI/CDパイプラインに統合することで、コードの変更が本番環境のAPIを壊さないことを保証します。

Postmanを使用して

始めるにあたって、基本的なリクエストをテストします。複数のリクエストをコレクションに保存することができ、これを再利用したり共有したりできます。

Postmanでは、各リクエストはワークスペース内の独自のタブを持っています。リクエスト設定のコントロールや、サーバーからの出力が表示されます。フルスクリーンで使用している場合、右下のボタンで横並びのカラムモードに切り替えることができます。

URLバーのドロップダウンからリクエストタイプを変更できます。最も一般的なメソッドはGETとPOSTですが、すべてのHTTP動詞が完全にサポートされています。

「認証」タブの下で、使用しているAPIの認証キーを設定する必要があります。公開されていない限り、PostmanはOAuth 1および2、ならびに基本認証とほとんどの他のトークンタイプをサポートしています。

「ヘッダー」では、Content-Typeなどのメッセージのヘッダーを設定できます。これらの多くは自動的に設定され、 「隠す」ボタンの下で表示できます。

リクエストの本文には、キーと値のペアを使用してフォームデータを指定することができます。バイナリパッケージ、GraphQLリクエストを送信するか、生のJSONまたはテキストデータを送信することもできます。エディターには、内蔵のJSONエディターとバリデーターが含まれています。

Postmanでできるクールなことの1つは、APIテストを設定することです。これらはJavaScriptでコーディングされており、結果を受け取った後に実行されます。設定方法については、Postmanの使い方ガイドを参照してください。

リクエストの準備ができたら、「送信」ボタンを使ってテストできます。リモートサーバーからの応答を得ることができ、それを整形表示、HTMLプレビュー、または生の出力として見ることができます。ステータスバーには、HTML応答コード、ペイロードサイズ、ピンなど、さまざまな統計情報が表示されます。

ドロップダウンを「ボディ」から「ヘッダー」に変更して、APIが返したヘッダーを表示することもできます。

JavaScriptテスターを使用することで、簡単なデータビジュアライゼーション、たとえば円グラフや棒グラフを作成することもでき、大量のデータを理解するのに役立ちます。

もしそれに戻りたい場合やテストを保存したい場合は、それを「コレクション」に保存できます。その後、上部のメニューバーからコレクションランナーを使用して、コレクション内のすべてのリクエストとテストを実行できます。これにより、すべてのAPIエンドポイントのユニットテストを行うことができます。