PostmanのモックサーバーにAPIキー認証をつけてプライベートで公開する
この記事は、Postman Advent Calendar 2024 20日目の記事です。
株式会社dottでバックエンドエンジニアをしているとみぎと申します。
前回の記事では、Postmanのモックサーバーの基本的な使い方をPostmanのMockServerを使ってみるの記事で紹介しました。
今回はその応用編ということで、タイトルの通り、作成したモックサーバーにAPIキー認証をつけてプライベートで公開する方法を紹介します。
TL;DR
- PostmanのモックサーバーにAPIキー認証をつけることで、モックサーバーをプライベートで公開することができる
- APIキーの発行はアカウント設定 から行う
- モックサーバーの設定画面で「モックサーバーをプライベートにする」にチェックを付けて、APIキー認証を有効にする
- モックサーバーのリクエスト時はヘッダーに
x-api-key
を追加してリクエストを行う
APIキーの発行
まず最初にAPI認証に必要なAPIキーを発行します。
アカウント設定のAPIKeysにアクセス
-
APIキーの発行はPostmanのアカウント設定から行うため、以下のリンクにアクセスします。
account settings -
アカウント設定にアクセスをしたら、サイドメニューの「API Keys」をクリックし、以下のAPI Keysの画面を表示します
APIキーを発行
-
API Keysの画面にアクセスをしたら、右上の「Generate API Key」をクリックします
-
クリックをすると、API Keyの名前を入力するウィンドウが表示されるので、名前を入力して「Generate API Key」をクリックします。
-
すると、API Keyが発行され、以下のような画面が表示されますので、
API Keyをコピーしておきます。 -
ウィンドウを閉じて、API Keysの画面に戻ると、発行したAPI Keyが表示されていることが確認できます。
API Keyの発行作業は以上です。
モックサーバーの設定を更新
では、ここからが本題。
モックサーバーの設定を更新します。
モックサーバーのプライベート設定を有効化
-
Postmanを起動後、作成したモックサーバーを表示したら
右上にある「設定を編集」ボタンをクリックし、モックサーバーの設定画面を表示します。 -
設定画面を開いたら、画面中央にある「モックサーバーをプライベートにする」にチェックを入れます。
-
チェックを入れたら「モックサーバーを更新」をクリックして設定を保存します。
これで、モックサーバーのプライベート設定が有効化されます。
リクエスト時の認証設定の追加
最後にモックサーバーの動作チェックをしてみましょう
認証設定なしの場合
以下のモックサーバーのAPIはプライベート設定前は200のレスポンスを返していましたが、
プライベート設定後は認証設定が無いと401エラーを返すようになりました。
APIキー認証を追加した場合
401エラーが返ってくることを確認できたので、次にリクエストに認証設定を追加していきます。
-
リクエストの「認可」のタブを選択し、Auth Typeを「API キー」に変更します。
-
キーには
x-api-key
を入力し、Valueには先ほど発行したAPI Keyを入力します。 -
上記の設定を行ったら、再度リクエストを送信してみます。
-
APIキーを含む認証設定があっていれば、200のステータスが返ってくることを確認できます。
以上が、PostmanのモックサーバーにAPIキー認証をつけてプライベートで公開する方法になります。
Discussion