目次
- Postmanとは？
- 準備
- メソッド
- コレクション
- リクエストをまとめて実行
- おわりに
Postmanとは?
Postmanとは、開発者がAPIを設計、構築、テスト、反復するためのAPIプラットフォームです。
Postmanを利用することで様々なAPIテストを実施することが可能です。
ここではPostmanの基本的な使い方などについて解説します。
準備
Postmanの入手
- ダウンロードページ（ https://www.postman.com/ ）からダウンロードします。
Windows、Mac、Linuxの３種類から自身の環境にあったものを選択。
インストール
手順に従ってインストールするだけです。
（Postman起動画面）
APIを用意する
APIは自身で作成したものやTwitterなどベンダーの開発したAPIを用意。
メソッド
メソッドには以下の様なタイプがあります。
| メソッド | リクエスト |
|---|---|
| GET | リソースを要求する |
| POST | リソースの更新を送信する |
| PUT | データを送信する |
| PATCH | リソースを部分的に更新する |
| DELETE | リソースを削除する |
| ・・・ |
基本的に使用するのは上の５つくらいです。
APIにリクエストを投げる
APIを実行するURLを入力し、メソッドを選択してSENDボタンを押します。
下の例ではhttp://localhost:8080/employee/all というローカル環境のURLで実行しています。
これはGETメソッドでDBの全レコードを取得するAPIを実行したものです。
正常にAPIが実行されれば200 OKというレスポンスが返って来ます。
コレクション
コレクションを作るとテストで実行するリクエストをまとめたりできるので
わかりやすく管理するためにも作成しておきましょう。
Collectionsを選択してNewで新規作成、Importで既に作成しているコレクションを取り込むことができます。
メニュー左のCollectionsからNewを押下すると新しいコレクションを追加できます。
コレクションに名前をつけてフォルダの様にリクエストを管理できます。
後述する、リクエストをまとめて実行する際もコレクションを使うと便利です。
BASE URLを指定する
コレクションにはBASE URLを指定することもできます。
APIを実行するURLのエンドポイントを予め登録することで、関連する複数のリクエストを作成する際にパラメーター部分だけ追加するなど編集が楽になります。
コレクションにリクエストを登録
コレクションを作成したら直下にリクエストを保存します。
リクエストをまとめて実行
コレクションに保存したリクエストをまとめて実行することもできます。
コレクションを選択し、・・・ボタンを押してRun collectionを押すと実行するリクエスト一覧が表示されます。
チェックボックスをクリックして実行するリクエストを選択できます。
右側のRun コレクション名ボタンをクリックするとリクエストがAPIに投げられます。
各APIからのレスポンス結果が表示されます。
おわりに
Postmanを使うと様々なAPIテストを実施することが出来て非常に便利です。
ここで紹介した以外にも便利な機能があるのでぜひ活用しましょう。