PostmanでWEB APIを叩く
こんにちは。今回はPostmanというツールを利用してWEB APIを実行する方法を解説していきます。開発者であればWEB APIを実行しなければならないシーンは遅かれ早かれ必ずあります。Postmanはシンプルで始めやすいのでこれを機にPostmanを覚えてみましょう。
なぜPostmanなのか
WEB APIを実行するツールは数多くありますが、私はPostmanをお勧めしています。インターフェースが非常にわかりやすく、初心者の方に導入してもらいやすいからです。私もそういった理由でプロジェクトで採用することが多々あります。
Postmanのインストール
次のURL(https://www.postman.com/downloads/)からダウンロードします。
アカウント作成を求められますが、画面下の[Skip and go to app]をクリックすると、アカウント登録せずに使い始めることができます。
![](https://i0.wp.com/e-seventh.s3.amazonaws.com/wp-content/uploads/2022/03/20094129/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88-2022-03-20-090224-1024x642.png?resize=1024%2C642&ssl=1)
PostmanでAPIを叩く
この章ではPostmanを使ってWEB APIを叩く手順を説明します。説明には郵便番号データ配信サービス(http://zipcloud.ibsnet.co.jp/doc/api)を使わせていただきます。
[Create a Request]をクリックします。新たなタブが開きますので、この画面でリクエストの内容を編集していきます。
[Enter Request URL]とプレースホルダーが表示されている箇所にAPIのURLを入力し、[Send]をクリックします。結果は画面下部で確認することができます。
![](https://i0.wp.com/e-seventh.s3.amazonaws.com/wp-content/uploads/2022/03/27081313/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88-2022-03-27-080859-1024x675.png?resize=1024%2C675&ssl=1)
基本的な使い方は以上となります。非常にシンプルなステップで実行することができました。
おまけ:JSONをPOSTする
一般的な使い方としてJsonデータをPostすることがよくありますので、最後にその方法を説明します。パラメータが多いタイプのAPIでは頻繁にこの形式を目にします。
まずはURL左横のHttpメソッドでPOSTを選択します。次に送信するJSONを入力します。URLの下にあるBodyをクリックし、展開されたメニューから[raw]> JSONをクリックします。その下に表示されている入力欄にJSONを入力すればOKです。
![](https://i0.wp.com/e-seventh.s3.amazonaws.com/wp-content/uploads/2022/03/27083106/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88-2022-03-27-082738-1024x246.png?resize=1024%2C246&ssl=1)
まとめ
いかがでしょうか。今回はPostmanでAPIを実行する方法を解説しました。
開発に携わっている人は多かれ少なかれAPIを実行しなければならないケースがあると思います。WEB開発を行う方はもちろん、そうでない方も他社サービスのAPI連携をする機会は増えてきています。ですのでPostmanのようなHttpクライアントツールを一つは覚えていく必要があります。今回紹介した通りPostmanはインターフェースがシンプルなので私としては凄くお勧めです。個人利用に限って無料なのもおいしいポイントです。これを機会にPostmanを覚えてみてはいかがでしょうか。
ディスカッション
コメント一覧
まだ、コメントがありません