マニュアル：Postmanでブール値を送信するには？

Postmanを使ってAPIをテストする際、時にはブール値を送信する必要があります。それでは、Postmanでブール値を送信するには、どうしたらいいですか？本文では、ブール値の送信が必要となる原因などの基本情報を完全に紹介した上、Postmanで簡単にブール値を送信する方法を皆さんに紹介します。

💡

Apidogを使えばパラメータのデータ型を直接Booleanに設定できるので、Postmanより簡単にブール値を送信できます。

APIテストの際に。ブール値を送信する必要がある場合、Apidogという無料なAPI管理ツールを使いましょう！

button

ブール値とは？

ブール値(boolean値)とは、真(true)か偽(false)の2つの値だけをとることができるデータ型のことです。

プログラミングにおいて、ブール値は論理演算や条件分岐などで広く利用されます。例えば:

ある条件が満たされているかどうかを表現する(true/false)
2つの値が等しいかどうかを判定する(true/false)
ある処理を実行するかしないかを判断する(true なら実行、false なら実行しない)

ブール値は0や1の値ではなく、trueまたはfalseという値を直接取ります。多くのプログラミング言語でサポートされている基本的なデータ型です。

論理演算子(AND, OR, NOTなど)を使ってブール値を組み合わせ、複雑な条件を表現することもできます。ブール値はプログラミングにおいて非常に重要な概念です。

APIでブール値がどこで利用される？

APIでは、ブール値が多く利用されています。例えば、以下のようなケースでは、ブール値が様々な用途で利用されています。

リソースの有効/無効や公開/非公開の状態を表す
例えば、ユーザーアカウントの有効/無効状態や、記事の公開/非公開状態などをブール値で表現します。
"is_active": true や "is_published": false などです。
フィルタリングやソート条件として利用
ブール値のクエリパラメータを使って、検索結果をフィルタリングしたり並び替えたりします。
/users?is_admin=true や /products?on_sale=true&in_stock=false など。
リソースの関連付けや所属関係を示す
例えば、"is_manager": true のように、ユーザーがマネージャー権限を持つかどうかなどを表します。
処理の成功/失敗を示す
APIの実行結果が成功したかどうかを "success": true/false のようにブール値で返すことがあります。
機能のオン/オフを切り替える
APIで提供される機能のオン/オフ設定を "feature_enabled": true/false のようにブール値で受け渡しします。
同意や確認を求める
フォームの同意チェックボックスの値など、"agreed": true のようにブール値で送信することがあります。

ブール値はシンプルかつ明示的で、真理値を表す上で非常に適した値です。APIではこのようにブール値を様々な用途で利用しています。

Postmanでブール値を送信するのはなぜ？

Postmanは、API（Application Programming Interface）開発とテストのための人気のあるツールです。Postmanを使用すると、開発者はHTTPリクエストを作成し、APIエンドポイントに送信することができるので、APIの動作をテストしたり、リクエストとレスポンスのデータを確認したりできます。

Postmanでブール値を送信する必要がある主な理由は、APIがブール値のパラメータやリクエストボディを期待している場合があるためです。具体的なケースは以下のようなものが考えられます：

APIのパラメータとしてブール値を渡す場合

例えば、/users?active=trueのようなAPIエンドポイントで、activeユーザーかどうかをブール値で指定する必要がある場合です。

リクエストボディにブール値が含まれる場合

JSON形式のリクエストボディに{"is_admin": true}のようにブール値のフィールドが存在し、それを送信する必要がある場合です。

フィルタリング条件としてブール値を使う場合

検索APIなどで、/products?on_sale=trueのようにon_saleフラグがtrueの商品のみを絞り込むような使い方です。

こういった場合、PostmanではBooleanタイプを選択するか、直接"true"や"false"と入力することでブール値を送信する必要があります。APIの仕様によってはブール値を期待しているため、Postmanでもそれに合わせてブール値を渡す必要があるのです。ブール値以外の文字列や数値を送信すると、APIからエラーが返されるおそれがあります。

Postmanでブール値を送信する手順

それでは、PostmanでAPIをテストする場合、ブール値を送信する必要がある場合、どのように実装すれば良いのでしょうか？次は、Postmanという汎用のAPIテスト用ツールを使って、簡単にブール値を送信する方法を皆さんに紹介します。

ステップ⒈Postmanでhttpリクエストを新規に作成して、httpメソッド、エンドポイントURLなどの基本情報を記入します。

ステップ⒉Pre-Request Scriptタブに切り替えて、次のようなスクリプトを記入します。

var bool = [true, false];
pm.globals.set('boolVal',  bool[Math.floor(Math.random()*bool.length)]);

"BoolVal": {{boolVal}},

このスクリプトは、{{boolVal}}というブール値が含まれる変数を定義しています。

ステップ⒊リクエストの画面に戻り、パラメータでブール値が含まれている変数を参照します。そして、「Send」ボタンをクリックして、リクエストを送信すれば、ブール値も一緒に送信します。

上記のように、Postmanでテストスクリプトを利用して、ブール値を含む変数を作成することができます。その後、リクエストのパラメータでこの変数を参照すれば、ブール値を簡単に送信することもできます。

Apidogでブール値をより簡単に送信

Postmanの代わりに、Apidogはより使いやすいAPI管理ツールになります。Apidogは、APIテストの他に、APIの設計、ドキュメンテーション、モックサーバーなどの機能も利用できますので、非常に便利なツールになります。

button

また、Apidogでブール値を送信する必要がある場合でも、それを簡単にパラメータに追加して送信することもできますので、ご活用ください。

ステップ⒈Apidogを開き、新しいリクエストを作成して、必要な情報を記入すると、パラメータのデータのタイプを直接に「Boolean」に指定することができます。

ステップ⒉そして、パラメータ名を記入して、パラメータ値を「true」か「false」を記入して、リクエストを送信することができます。リクエストが送信されると、「実際のRequest」タブで、ブール値が成功に渡されたことを確認できますね。

上記のように、Apidogでリクエストを送信する際、パラメータのタイプを直接に「Boolean（ブール）」に指定して、Postmanよりも便利にブール値を送信することができますね。

button

まとめ

ブール値は真理値を表す上で非常に重要なデータ型であり、APIでは様々な場所で利用されています。APIがブール値のパラメータやリクエストボディを期待している場合、Postmanでもブール値を正しく送信する必要があります。本記事では、Postman でAPIテストを行う際にブール値を送信する必要がある理由と方法について詳しく解説しました。

Postmanでブール値を送信するには、Pre-Request Scriptを使ってブール値を含む変数を作成し、その変数をリクエストのパラメータで参照する方法があります。一方、Apidogを使えばパラメータのデータ型を直接Booleanに設定できるので、より簡単にブール値を送信できます。

APIの開発やテストを効率的に行うには、ツールを適切に活用してブール値を正しく扱うことが重要です。本記事で紹介した方法を参考に、開発の生産性を高めていきましょう。Postmanだけでなく、Apidogのようなより高機能なツールも積極的に活用することをおすすめします。