こんにちは！ 福岡でエンジニアをしているはっしーです！
普段はC#、.NET、Azureなどの技術を使ってWebアプリケーションを開発しています。
バックエンド寄りです！
今回は、新規でPostmanのWebAPIのコレクション、リクエストを作成するときにPostmanのテンプレートライブラリが便利だったので紹介します！
はじめに
みなさんは自身で開発しているWebAPIをテストする際、どんな流れでPostmanを使用していますか？
このような流れが多いのではないでしょうか？
- ワークスペースで新しいコレクションを作成する
- コレクションにリクエストを追加する
- 対象のAPIにリクエストを送るためにHTTPメソッド、エンドポイント、ヘッダーなどを設定する
CRUD操作を行うREST APIだったら、HTTPメソッドごとにリクエストを作らないとですね。
- GET
- POST
- PATCH
- DELETE
あとは使いやすいようにBaseURLなどの変数の設定を行ったりしますよね。
並べてみると簡単だけど少し手間ですよね...
Postmanのテンプレートライブラリ
Postmanには、WebAPIのワークフローを開始するためのフレームワークを提供する無料でカスタム可能なテンプレートがあります。
https://www.postman.com/templates/
テンプレートには、バックエンドエンジニア、フロントエンドエンジニア、フルスタックエンジニア、QAエンジニアなどの役割に応じたものがあります。
また、プロトタイピング、ドキュメンテーション、テスト、デモなので特定のユースケースのためのテンプレートもあります。
テンプレートを使うことでWebAPIをテストをさくっと開始することができます。
テンプレートを見てみよう
REST API basics テンプレート
-
テンプレートを選択する
-
ワークスペースを選択
テンプレートの中身
CRUD用のリクエストがあります
ちなみにPostmanはこちらの右上のボタンを押すと、使用されている変数を一覧で確認することができます
変数を確認するとBaseURLが設定されてます
あとはレスポンスのステータスをテストするためのスクリプトも記述されてます
シンプルな構成ですね。テンプレートをベースにCRUD 操作 (GET、POST、PUT、DELETE)、変数、およびテストを含むリクエストをさくっと作成することができますね
Integration testing basics テンプレート
- テンプレートには登録、登録したユーザー名の取得、登録解除の3つのリクエストが含まれています
- 実行ボタンを選択します
- 「Run Integration testing basics」を押すと、3つのエンドポイントを使用した統合テストを行うことができます
こちらのテンプレートをベースにするとWebAPIの統合テストをさくっと作成することができますね
まとめ
テンプレートを使用した方が断然早くWebAPIのテストを行うことができます。
最近はもっぱらテンプレートを使用して始めているのでおすすめです。
また、統合テストやE2Eテストなど初めのうちは1から記述するのは大変なワークフローもテンプレートを使用すると書きやすいです。
是非WebAPIのテストを始める際はテンプレートを使用してみてください。
最後まで読んでいただきありがとうございました。