5
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

ブラウザ版のPostmanを使用して、laravelにapiの動作確認を行う

Last updated at Posted at 2022-04-16

こんばんは、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をクリック

image.png

Create Workspaceをクリック

image.png

任意の名前、概要などを記入してワークスペースの作成を行う。

image.png

collectionの作成

collectionsを選択し、+ボタンを押す。

image.png

そうすると下記画像のようにあたらしいcollectionができる。

image.png

HTTPリクエストの作成

New Collectionの横の>を押して、Add a requestをクリック

image.png

下記のような画面になるので、この画面からリクエストの編集を行う。
今回はpostリクエストを行うので、赤枠部分の箇所を任意の値に設定する。

image.png

PostmanAgentのインストール

リクエストを送る場合、PostmanAgentをインストールしていないと、エラーになるのでインストールする必要がある。
下記記事を参考にして、PostmanAgentをインストール

動作確認

Sendをクリック

image.png

以上になります!

最後に

調べてみると、レスポンスデータの値が自分の期待する値がどうかも確認できるようで、以前railsを使用してAPIを作成していたときはtを書いてAPIのテストを行っていたのですがPostmanでもテストができそうです!
アプリ側でテストを書くか、Postman側でテストを書くかどうかはまだ決めてないのですが、このような選択肢もあるということを知れて少し引き出しが増えた気がします!

最後に、もしこの記事を読んでいただいて、役に立ったと感じて頂けましたらLGTMをいただけますと幸いです💦(記事執筆のモチベーションになりますw)

5
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
5
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?