3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

PostmanAdvent Calendar 2024

Day 5

Postman 練習環境でApiキー認証を試してみた

Last updated at Posted at 2024-12-04

はじめに

日々の活動、ご苦労様です!!
先日、Postmanオンラインワークショップ - API認証 に参加しました!

前回参加後にはテストスクリプトの練習環境を構築しましたが、本記事ではこの環境に、認証ハンズオンの内容を取り入れていきたいと思います!:fist:

  • 前回記事

やること

  • 復習を兼ねたApiキー認証の練習
  • 前回環境にApiキー認証を適用

Apiキー認証の練習準備

ワークショップでフォークした以外のコレクションで練習してみたいなぁと思っていたところ、ちょうど良いAPIを見つけたので利用します!

1. THE CAT API のPostmanをフォーク
2. 認証キーを取得

練習開始

1. 用意されている環境変数の現在値に先ほど取得した認証キーを入力します image.png

2. コレクショントップの認可を画像のように設定します
image.png

3. imagesで画像を取得しそのidをfavouritesでpostします
image.png
image.png

4. postのレスポンスにあるidを使用してお気に入り登録できているか確認しますimage.png

5. 認証キーを削る
方法はなんでも良いと思いますが、正しい認証キーでなければ401となることが確認できます
image.png

ワークショップで行ったApiキー認証ハンズオンの範囲はこんな感じだったと思いますので練習には最適でした!

次はApiキー認証自体を自作します

Apiキー認証が必要なApiを作ってみる

前章で構築した環境にApiキー認証を追加する

既に実装済みのコードとPostman json は用意しているので下記ブランチに移動して、環境とワークショップをimportして下さい。(import方法などは前章を参考にして下さい)

対象リポジトリ:postman_practice repository
対象ブランチ:postman_auth_apikey
Postman json: utils/postman/auth

環境変数を追加する

.env
API_KEY=123456789

image.png

Apiキーによる認証を試す

認証エラーになるかを見たいので、先ほど設定したどちらかの環境変数を適当なものに変更してリクエストを投げてみて下さい。
リクエストヘッダーにx-api-keyが付与され、401エラーの返却が確認できますね!

image.png

今後の課題

業務で活用する認証方法やハンズオン内で触れられていたOAuthでのテストも練習したいので、時間を見つけて試行してみたいです。

終わりに

最後までお読みいただきありがとうございます!!
業務ではApiDogを使用してきたので、これまでPostmanを利用する機会はなかったのですが、ワークショップを通じてある程度触れるようになれました!
まだ今年中に2回ワークショップがあるのでどちらも参加して、さらに使いこなせるようになります:sunglasses:

追伸

アドカレ5記事目終わり〜
まだ1/5 :joy:
きちぃのは間違い無いですが、他にも頑張っている方々がいるので団体スポーツだと思って走ります!!

:santa_tone1::santa_tone1::santa_tone1::santa_tone1::santa_tone1:

3
0
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
3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?