APIのPOSTやPUTもできる便利ツール【Postman】について

APIのPOSTやPUTもできる便利ツール【Postman】について

SPA設計している方なら知らない方はいないんじゃないかと思う便利ツールに【Postman】があります。
APIの設計をしていると、スクリプトテストをするためのスクリプトを作ったりと手数が多くなることがあります。
特に、オリジナルなTokenを設計する必要が出た時など、API系の問題切り分けにとても役立ちます。

そのトークン生きてる？

CRUDで言う所のReadであればgetでもらうだけなので大きな問題にはならないかもしれません。
でも、SPAではCreateもUpdateもDeleteも出てきます。
そして、これらにはTokenという認証方法が利用されます。
Laravelなどフレームワーク標準のTokenを利用する場合はまだ良いのですが、現場ではオリジナルTokenを構築することもあります。
そんな時「Tokenが正しく機能しているか」の確認が必要なのですが、Tokenチェックのスクリプトを書いてチェックすると、スクリプトに問題がある可能性も否定できず、本来的な課題の発見に時間がかかる可能性を排除できません。

そんな時に便利なのがこの記事にて紹介するPostmanです。

Postmanの使い方

2つの方法があります。

ただ、どちらもログインが必要となるため、PCのメモリを使ってインストール＆利用する必要なないと思います。
自分のPCにインストールしたい方はこちらから必要なアプリをダウンロードしましょう。

postmanの基本操作は左画像画面の【+】をクリックするところから始まります。
この操作で、APIエンドポイントについて記載する右画像の画面が開きます。
GETなのかPOSTなのかなどの情報とともに、Tokenを記載する箇所があるので、ここに発行されたTokenを記載します。
設定が完了したらSendをクリックすれば処理完了。

GETであれば返ってきた値を直接参照することで確認できますし、POSTであればサーバーサイドで意図した動作をしているか確認しましょう。

まとめ

Tokenの有効性確認で面倒なのがハッシュ化です。
SQLの中身みても正しいTokenを取得できません。
ここら辺については、Token発行時にLogに生 Token記載させるなど、いくつかの手段があります。

オリジナルTokenは面倒な実装ですが、やってやれないことはない！
がんばりましょう！