はじめに
業務でAPIの作成をしたのですが、テストの際にとても役立ったPostmanについて皆さんにも知って欲しいと思い、記事を書きました！
Postmanとは？
URLやRequestの内容、TOKENを設定してAPIにRequestを送り、Responseを確認することができるツールで、Web APIの開発者「提供する側・活用する側」の双方にとってより良い開発エクスペリエンスを提供するクライアントアプリケーションです。
主な機能の特徴
- API Client
- 公開されているもしくは開発中の各種APIを簡単にテストできる機能です。
- Automated Testing
- API開発者向けに各エンドポイントに対する自動テスト機能を提供します。
- Design & Mock
- APIを開発するにあたって、API SchemaをDesignするための専用EditorとそれをテスティングするためのMock Server機能を提供します。
- Documentation
- PostmanのAPI定義から自動的にAPIドキュメントを生成し、外部ユーザーに提供することができる機能です。
- Monitors
- 提供されているAPIを定期的にチェックし、APIのアップデートや変更に伴う破損や従来のエクスペリエンスに変化が無いかモニタリングすることができます。
- Workspaces
- チームでAPIを共同開発するためのコラボレーション機能を提供します。
インストール方法
こちらのURLからダウンロードして、インストールします。
Web APIを使うために抑えたい重要な要素
- Base URI
- 一番最初に知らなければいけないことは、Web APIを提供しているサービサーのURIエンドポイントを特定すること。
<例>
https://qiita.com/api/v2/items
- Resource
- Web APIではどんなデータを操作するのかを決める必要があります。それをBase URIと合わせて指定するのがWeb API（REST）では一般的です。
<例>
# itemsがResourceにあたり、このitemsに対してなんらかの操作を行う
https://qiita.com/api/v2/items
-
Method
- GETやPOST・PUT・DELETEといったリソースに対する操作方法を指定する。
-
Authentication
- Web APIを操作するための認証部分。
-
Header
- 対象のAPIに対して、追加情報を渡すために使用されるプロパティセットのこと。
- 主に後述する認証情報やどんなフォーマットでデータの受け渡しを行うか？を指定する。
-
Query
- Queryは主にデータを取得する際の各種諸条件を適用するために使われるパラメータセットのこと。
- URIとリソースを指定した後に続く文字列として「？」以降に指定するものがQueryです。
-
Body
- Web APIに渡すためのメインとなるデータを指定するための要素。
- 主にPOSTやPUTでリソースにデータを登録したり、更新したりする時に指定する。
使い方
1.Postman を立ち上げて、まずは対象となる Web APIのBase URIを指定する。
2.対象のリソースを指定します。
3.プルダウンで各Methodを選択することができるので、該当のリクエストを選択する。
4.次にQueryを指定します。Paramsタブで指定を行います。Paramsタブを選択し、KeyとValueを指定します。このParamsタブにデータを入力すると、自動的にURIへQueryが補完されます。
5.APIを実際にリクエストするにはPostman右上にある「Send」ボタンをクリック。
グローバルで Web APIを展開しているサービスのテンプレートを使う
1.Postman API Network にアクセスする。
2.任意のAPIを検索して、「Run in Postman」をクリックする。
Postman API Network以外のAPIを使う
1.任意のサイト等でAPIをダウンロードしてくる。(例:freee)
2.取得したOpenAPISpecは、PostmanのImport機能から取り込む。画面右上の「Import」をクリック
3.「Import File」タブから、ダウンロードしたOpenAPI（Swagger）Specを指定する。
4.API情報が取り込まれる。
プログラムからWeb APIを操作する
1.Code Snippetのプルダウンから任意の言語を選択する。
2.出てきたコードをペースト。
終わりに
どうでしたでしょうか？
APIの作成には、必要不可欠くらい便利なツールですよね笑
どんどん活用して行こう！