WEB API ブログ プログラミング

【 API 開発ツール 】Postman のインストール方法と使い方(API リクエストの送信方法)

今回はAPI開発ツールの「Postman」について、インストール方法と使い方を解説します。

Postmanとは

Postmanとは、API開発ツールの一つで、API開発に必要な便利な機能がいくつも用意されています。

  • ドキュメント(API設計書等)の作成
  • モックサーバーの構築
  • APIクライアント
  • 自動テスト(APIごとにテストケース作成)
  • APIパフォーマンスのモニタリング

インストール方法

こちらからフリーでインストーラーをダウンロードして、インストールを実行します。

WindowsMacLinuxのOSに対応しているので、それぞれ自分の端末のOSに対応しているインストーラーをダウンロードしてください。

Postmanのダウンロードサイト
Postmanのインストール中画面


正常にインストールできていれば、Postmanを起動すると以下のような画面が表示されます。

Postmanの初期表示画面

Postmanの使い方(APIリクエストの送信)

API開発において、最も使用する機能としては「APIリクエストの送信」だと思います。

以下のPostmanの画面を例に簡単なAPIリクエストの送信方法を解説します。

まずはじめに、の「Enter request URL」というフォームに対象となるAPIの送信先URLを入力します。

その次に、でHTTPリクエストの種類(GET、POST、PUT、DELETEなど)を選択し、の「Send」ボタンをクリックすることで

に入力したURL先のAPIにリクエストを送信することができます。

また、送信先のAPIに対してPOSTやPUTなどのリクエストで何か情報を送信したい場合があると思います。

例えばJSONの場合だと、の「Body」タブを選択後、で「raw」の「JSON」という形式を選択して、

の入力欄に送信したいJSONを入力することでリクエスト送信時に入力したJSONをAPI側に送信することができます。

にはリクエスト送信後にAPI側からのレスポンス(リクエスト送信の成功/失敗、GETなら返却されたJSONなど)が表示されます。

Postman APIリクエスト送信方法の例

他の機能については別記事にまとめていきたいと思います。

おすすめ記事はコチラ

スマレジ テックファーム 1

スマレジ テックファーム で Webエンジニアとして勤めている tomoです。 今回は株式会社スマレジや私が所属している 「 スマレジ テックファーム 」についてPRしていきたいと思います。 スマレジ ...

2

FromBody 属性を使用して、 ASP.NET Core(.NET 6)のWebAPIでBodyパラメータのJSONを受け取る方法を解説します。 FromBody 属性 POSTやGETで呼び出さ ...

PC picture 3

ASP.NET Core(.NET 6)でCookie認証のタイムアウトを設定する方法を解説します。 Cookieの有効期限について Cookieには通常はタイムアウト(有効期限)を設定します。 基本 ...

4

ASP.NET Core(.NET 6)でクロスオリジンリクエスト ( CORS )を設定する方法を解説します。 簡単に クロスオリジンリクエスト ( CORS )とは何かについても少し解説したいと思 ...

-WEB API, ブログ, プログラミング
-, ,