Apidog

オールインワンのAPI開発プラットフォーム

API設計

API仕様書生成

API設計

API Mock

APIテスト自動化

無料登録
Home / 操作ガイド / 初心者向け:Postmanの基本的な使い方を

初心者向け:Postmanの基本的な使い方を

Postmanは、APIテストなどを行うための定番のツールになります。API戦略を実施する場合は、Postmanを利用することで、その効率性を大幅に向上できます。そこで、本文では、基本的なPostmanの使い方を皆さんに紹介して、Postmanを全く使ったことがないユーザーでも、本文の内容を参照して、Postmanを使いこなすことができると思います。

Postmanは、APIテストなどを行うための定番のツールになります。API戦略を実施する場合は、Postmanを利用することで、その効率性を大幅に向上できます。そこで、本文では、基本的なPostmanの使い方を皆さんに紹介して、Postmanを全く使ったことがないユーザーでも、本文の内容を参照して、Postmanを使いこなすことができると思います。

また、Postmanより使いやすくて、制限が少ないAPI管理ツールのApidogを皆さんにお勧めします。Apidogは日本語にも対応できますし、コレクション実行んの制限が全くないので、Postmanより効率よくAPIを管理することができます。

button

Postmanとは

Postmanは、API(Application Programming Interface)開発とテストのための人気のあるツールです。Postmanを使用すると、開発者はHTTPリクエストを作成し、APIエンドポイントに送信することができるので、APIの動作をテストしたり、リクエストとレスポンスのデータを確認したりできます。また、Postmanは、機能豊富なインターフェースを提供し、リクエストの作成や編集、ヘッダーの管理、パラメータの設定、レスポンスの確認などを行うことができます。

Postman

Postmanのダウンロードとインストール

Postmanを使って、APIをテストしたりする前提として、Postmanをダウンロードしてパソコンにインストールするか、PostmanのWebアプリを使用する必要があります。Postmanのデスクトップアプリは、Windows、macOS及びLinuxで動作できるので、詳細なPostmanインストールガイドは、次の記事をご参照ください:

Postmanダウンロード&インストール(Windows, Mac, Linux)
Postmanを導入して効率的かつ信頼性の高いAPIを構築したい場合、どうやってPostmanをダウンロードしてインストールしますか?本文では、Postmanをダウンロードしてインストールする最も詳しい操作ガイドを皆さんに紹介します。

Postman基本的な使い方を完全解説

上記の手順を使用して、Postmanをパソコンにインストールするか、Webアプリを利用すると、次のガイドを参照して、Postmanを使いこなすことができると思います。

REST APIをテスト

多くのユーザーは、主にRESTful APIをテストするためにPostmanを利用しています。そこで、REST APIをテストするニーズも比較的に多くなります。Postmanは、REST APIエンドポイントの単体テストも、多くのAPIエンドポイントを一括にテストすることもできます。詳しくは:

最新ガイド:PostmanでAPIのテストを行う方法
Postmanは一番知名度が高いAPIテストツールになります。多くのユーザーは、主にRESTful APIをテストするために、Postmanを利用しています。本文では、このツールを使って、APIのテストを展開する方法を皆さんに紹介します。

HTTPリクエスト送信

HTTPはAPIで一番汎用されているプロトコルになります。そこで、HTTPリクエストを送信してレスポンスを取得することは、APIテスト時に一番重要な操作になると思います。Postmanは、一番有名なAPI管理ツールとして、HTTP /HTTPSリクエストの送信にも完璧に対応できます。Postmanの直感的なUIで、HTTPやHTTPSリクエストを簡単に送信できます。

操作ガイド:PostmanでHTTP/HTTPSリクエストを送信する
HTTP /HTTPSリクエストを送信するには、どうしたらいいですか?次は、有名なPostmanでそれを送信する方法を紹介します。また、Posmanは日本語に対応していないので、日本語化UIが備え、Postmanより使いやすいApidogで送信する方法をも一緒に紹介します。
HTTPリクエストのパラメータを入力 Postman

PostmanでPOSTリクエストを実装

POSTは、HTTPメソッドの一種として、主に指定のサーバーにリソースを追加するように使われています。POSTメソッドを使えば、サーバーでリソースを登録したり、更新したりするなど、書き込み操作がある処理を行うことができます。

 POSTメソッドを選択

Postmanを使って、POSTリクエストを送信できます。Postmanを使うことで、クライアント側からJSONファイルXMLなどの形式で、データをサーバー側に渡したりすることができますので、非常に便利です。

使い方:PostmanでPOSTリクエストを送信する
APIをテストする時に、POSTというメソッドは非常に汎用されているHTTPメソッドになります。本文では、Postmanというよく使われるAPIテスト用のツールを使って、POSTリクエストを簡単に送信する方法を皆さんに紹介します。

PostmanでSOAP APIをテスト

大企業を中心にエンタープライズシステム間の連携などで、SOAP APIはよく活用されています。これらのユーザーに対して、PostmanはSOAP APIのテストにも対応できます。

究極ガイド:PostmanでSOAP APIリクエストを送信する
大企業を中心にエンタープライズシステム間の連携などで、SOAP APIはよく活用されています。それでは、SOAP APIのリクエストを送信したり、レスポンスを検証したりするため、どうしたらいいですか?本文では、有名なAPIテストツールのPostmanを使って、SOAP APIリクエストを送信する方法を皆さんに紹介します。

PostmanでリクエストのメソッドをPOSTに指定した上、リクエストのHeadersでContent-Typeを「text/xml」に設定し、SOAPActionを利用中のHTTPメソッドに設定することで、SOAP APIのテストが行えます。

  • Content-Type: application/xmlという項目のチェックをはずします。
  • Content-Typeフィールドを別途作成し、その値を「text/xml」に設定します。
  • SOAPActionフィールドを追加して、その値「#POST」に設定します。
リクエストのheadersの設定

PostmanでWebSocket APIをテスト

WebSocket APIは、双方向のリアルタイム通信を実現するためのプロトコルとAPIの組み合わせです。通常のHTTPリクエストとは異なり、クライアントとサーバーが接続を確立した後、両者がデータを相互に送受信するためのパーマネントな接続を提供します。

究極ガイド:PostmanでWebSocket APIをテストする
Postmanは、広く使われているAPIテスト用ツールとして、WebSocketにも互換しています。Postmanを使うことで、WebSocketのリクエストを作成したり、送信したりすることができます。本文では、Postmanを使って、WebSocketを徹底的にテストする方法を紹介します。

Postmanは広く使われているAPIテスト用ツールとして、WebSocketにも互換しています。Postmanを使うことで、WebSocketのリクエストを作成したり、送信したりすることができます。

PostmanでWebSocketのRequest

Postmanでモックサーバーを作成

モックサーバーとは、実際のサーバーを模した仮想のサーバー環境のことです。モックサーバーを利用すると、実際のAPIサーバーが完成していない場合でも、APIのテストが行えます。そこで、APIのテスト中に、業務の都合によってモックサーバーを作成する必要がある場合がよくあります。

Postmanでモックサーバー(Mock Server)を作成!
APIのテスト中に、業務の都合によってモックサーバーを作成する必要がある場合がよくあります。それでは、Postmanでモックサーバーを作成するにはどうしたらいいですか?本文では、Postmanでモックサーバーの作り方を皆さんに紹介します。

Postmanは非常に汎用されているAPIテスト用ツールとして、内蔵のモックサーバーがあります。Postmanのモックサーバーは実際のサーバーの動作をシミュレートすることができるので、テストのプロセスをかなり効率化にすることができます。

Mock Serverの詳細を設定

Postman環境変数の利用ガイド

Postmanの環境変数(Environment Variables)は、Postmanの環境(Environment)に関連付けられた変数のことを指します。これらの変数は、APIの開発やテストの際に使用される設定値やデータを表現します。Postmanの環境変数を使用することで、リクエストURL、ヘッダー、ボディのデータなど、さまざまな箇所で動的な値を設定できます。

2023最新:Postmanの環境変数の使い方を完全解説!
Postmanの環境を利用する時に、必ず環境変数というものを使う必要があります。それでは、Postmanの環境変数とはなんですか?どのように利用しますか?本文では、Postmanの環境変数を詳しく紹介した上、その使い方を完全に解説していきたいと思います。
postman環境変数の追加

これにより、APIエンドポイントやパラメータ、認証情報などを簡単に切り替えたり、再利用したりすることができます。

Postman環境の活用ガイド

Postmanの環境(Environment)は、リクエストで使用できるPostmanの変数のセットです。Postmanで環境を使用して関連の設定値や変数をグループ化し、それらをまとめて管理するための機能です。開発の段階などにより、異なる環境をセットアップすることができます。

徹底解説:Postman Environment(環境)の使い方
Postmanを利用してAPI開発の効率化を実現する場合、必ずPostmanの環境(Environment)機能を使う必要があります。本文では、Postmanの環境機能の使い方について、徹底的に解説していきます。

Postman環境では、環境変数、グローバル変数及びローカル変数を利用することができるので、APIのテスト効率を大幅に向上することができます。

postmanの環境を作成

PostmanでOAuth 2.0認証を実装

OAuth 2.0は、ユーザーがWebサイトやアプリケーションにおいて安全にリソースへのアクセスを許可するためのオープンスタンダードのプロトコルです。ユーザーは自分のアクセス権を管理し、必要な場合にいつでもアクセスを取り消すことができます。また、サードパーティアプリケーションはユーザーのパスワードを保存する必要がなく、アクセストークンを使用することで安全なアクセスを実現します。

操作ガイド:PostmanでOAuth 2.0認証を実装する
OAuth 2.0は、APIのセキュリティを確保できる一般的な方法を提供します。本文では、Postmanを使ってOAuth 2.0認証を実行する方法を皆さんに紹介します。

Postmanでauthorizationタブで様々な情報を設定することで、簡単にOAuth 2.0を実装することができます。

PostmanでOAuth 2.0

PostmanでcURLをインポート

CURLとは、コマンドラインからHTTP通信を行うためのオープンソースのライブラリやツールのことです。Postmanの他に、APIリクエストを送信する際に、CURLを使用するケースも非常に多いのです。これにより、CURLとPostmanを併用して、リクエストを送信してAPIをテストしたりする必要がある場合が多くなります。

PostmanでCURLリクエストをインポートする方法
CURLとPostmanを併用して、リクエストを送信してAPIをテストしたりする必要がある場合がますます多くなります。本文では、Postmanに、CURLリクエストをインポートして送信する方法をみんさんに紹介します。

そこで、Postmanは、cURLからデータを簡単にインポートする機能を提供しています。

PostmanでcURLからデータをインポート

Postmanコレクションのエクスポート

Postmanのコレクション(Collection)は、PostmanというAPI開発ツールで使用される、関連するAPIリクエストのグループ化と管理を目的としたファイル形式です。コレクションは、APIエンドポイントへのリクエスト、リクエストパラメータ、ヘッダー、ボディデータ、認証情報などのAPIテストに必要な情報を含むことができます。複数のAPIリクエストを組織化し、一括実行やテストシナリオの作成、ドキュメンテーションなどの目的で使用されます。

解説:Postman Collectionのデータのエクスポート・インポート方法
本文では、Postmanのコレクションのエクスポート・インポートする方法を皆さんに紹介します。より直感的で使いやすいApidogに切り替えることで、Postmanのコレクションの制限をなくし、作業の効率をより一層高めることができます。

Postmanのコレクション情報を共有したり、他のアプリに切り替えたりするなどの場合、Postmanコレクションのエクスポート・インポートする必要があります。

Postmanコレクションのエクスポート

Newmanの使い方

Newmanとは、PostmanはAPIのテストやドキュメント作成などに用いられるツールですが、GUIベースのアプリケーションです。NewmanはNode.jsで開発されていて、Postmanで作成したコレクションや環境を入力として実行できます。レポート機能もあり、テスト結果をJSONやHTML形式で出力できます。

Postman Newmanとは、その使い方を解説
APIのテストの効率をかなり高めるために、PostmanのコマンドラインツールであるNewmanを利用する必要がよくあります。本文では、Newmanの使い方を皆さんに完全に解説します。

PostmanとNewmanを組み合わせることで、GUIの利便性とスクリプティングの柔軟性を両立できるため、APIテスト自動化に理想的なツールといえます。

対策:Postman使用上の問題を解消

APIを開発したり、テストしたりする必要がある場合、Postmanはもちろん非常に便利なツールになりますが、一定の制限があるとも見られています。次は、多くのユーザーが不満を抱いているPostmnaの使用上の問題を皆さんに紹介した上、その対策についても紹介していきたいと思います。

PostmanはHTTP/2に非対応

2017年以来、いろんなユーザーは、PostmanがHTTP2というプロトコルをサポートすることを期待しています。しかし、6年も経ていた今、PostmanはまだHTTP2をサポートしていません。

Postman HTTP2非対応問題:HTTP2のAPIのテスト方法はこちら
2017年以来、いろんなユーザーは、PostmanがHTTP2というプロトコルをサポートすることを期待しています。しかし、6年も経ていた今、PostmanはまだHTTP2をサポートしていません。本文では、HTTP2の基本情報を紹介した上、HTTP2のAPIをテストする方法を皆さんに紹介します。

Postmanの現状として、HTTP2をサポートしていないので、HTTP2を採用しているAPIをテストすると、レスポンスで「Could not get response(レスポンスを取得できない)」というエラーが表示され、テストに失敗しています。

Postmanはhttp2に非対応

そこで、HTTP/2プロトコルを使用するAPIをテストするために、Postmanは役に立ちませんので、ApidogなどのHTTP/2にも対応可能なAPI管理ツールを使用する必要があります。

button

Postmanのコレクションランナーに制限がある問題

Postmanは、2023年2月15日から無料顧客に対して、次のような制限を課すことにしました。既存の有料プランのお客様は、2023年3月15日以降のプラン更新時に同じ制限が有効になります(エンタープライズユーザーを除く)。

Postmanのコレクションランナーの制限:FreeとBasicプランを利用しているユーザーは、1ヶ月間でコレクションを最大25回実行できます。Professionalプランのユーザーは、1ヶ月で間最大250回実行できます。Postmanで上限に達したら、「 You have exhausted all the runs. To keep running collections, create an account..(実行回数を使い切りました。コレクションの実行を続けるには、アカウントを作成してください。)」といったエラーが発生します。

解決済み:Postmanコレクションランナーの制限を解消
Postmanは、コレクションランナーの上限に達すと、「 You have exhausted all the runs. 」エラーが発生します。このエラーは、APIテスト作業の邪魔になっています。本文では、Postmanコレクション制限を無料で解消する対策を皆さんに紹介します。

もしコレクションランナーの数的な制限に達していて、それ以上コレクションを実行したい場合、Apidogという制限がないAPIテストツールに切り替える必要があります。Postmanとは異なり、Apidogはコレクションの作成と実行に制限を設けていないので、開発者は、思い通りにコレクションを作成したり、実行したりすることが許可されます。

Apidogのテストのレポートの取得

まとめ

この記事では、APIテストツールのPostmanの基本的な使い方について解説しています。

まず、Postmanの概要とインストール方法について説明しています。次に、Postmanの具体的な使用方法として、REST APIのテスト、HTTPリクエストの送信、POSTリクエストの実装、SOAP APIのテスト、WebSocket APIのテストなどを紹介しています。さらに、Postmanの便利な機能として、モックサーバーの作成、環境変数の利用、コレクションのエクスポートなどについて解説しています。

最後に、Postmanの課題としてHTTP/2への非対応、コレクションランナーの制限などをあげ、これらの問題を解決するためにApidogなどの別のツールを利用することができます。

button

Apidogのニュースレターを購読する

今すぐ購読すると、いつでもApidogから更新情報と最新観点を手に入れることができます。