こんばんは、kumaです。
現在プライベートでReactとlarvelで共同開発を行っており、その際にAPIの動作確認をPostmanを使用して行ったので、その際の確認方法を備忘録として残していきたいと思います!
自分と同じように、初めてPostmanを使用する方のお役に立てれば幸いです💦
Postmanとは
Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
→ WebAPI開発を行う上で、自分でパラメータやtokenの中身を設定してHTTPリクエストを行ったり、返ってきたレスポンスデータの中身を確認したりできるツール。返却値が正しいものかどうかテストできたりもするらしい。他にもいろいろ機能があるみたい。
動作確認手順
予め、laravel側でAPIを用意していると仮定します。
また、postmanにはwebクライアント版も存在しますが、MacOS11以上でないと対応しておらず、今回はブラウザ版で動作確認を行うことにしました。(本当はOSを上げてwebクライアント版を使用するのが推奨されているようなのですが、OSを上げて他の部分に影響が出るのがとても怖かったので今回はブラウザ版で対応しております。)
postmanへの登録
postmanの公式ページから、ユーザー登録を行う。
ワークスペースの作成
https://web.postman.co/home に移動し、下記画像の左側にあるWorkspaces
をクリック
Create Workspace
をクリック
任意の名前、概要などを記入してワークスペースの作成を行う。
collectionの作成
collections
を選択し、+ボタン
を押す。
そうすると下記画像のようにあたらしいcollectionができる。
HTTPリクエストの作成
New Collection
の横の>
を押して、Add a request
をクリック
下記のような画面になるので、この画面からリクエストの編集を行う。
今回はpostリクエストを行うので、赤枠部分の箇所を任意の値に設定する。
PostmanAgentのインストール
リクエストを送る場合、PostmanAgentをインストールしていないと、エラーになるのでインストールする必要がある。
下記記事を参考にして、PostmanAgentをインストール
動作確認
Send
をクリック
以上になります!
最後に
調べてみると、レスポンスデータの値が自分の期待する値がどうかも確認できるようで、以前railsを使用してAPIを作成していたときはtを書いてAPIのテストを行っていたのですがPostmanでもテストができそうです!
アプリ側でテストを書くか、Postman側でテストを書くかどうかはまだ決めてないのですが、このような選択肢もあるということを知れて少し引き出しが増えた気がします!
最後に、もしこの記事を読んでいただいて、役に立ったと感じて頂けましたらLGTMをいただけますと幸いです💦(記事執筆のモチベーションになりますw)