Postmanとは?API開発ツールのインストールの手順と使い方を初心者向けに説明!

Postmanとは?API開発ツールのインストールの手順と使い方を初心者向けに説明!

この記事では、APIテストのための定番ツールであるPostmanについて初めて使う人にも分かりやすいように説明していきたい。

PostmanはAPIのテストをおこなうためのツールで、簡単にHTTP通信をおこないリクエストを受信することができる。Webアプリケーションの制作に携わるのであれば、必須のツールなのでぜひ使い方を覚えておきたい。

この記事では、TwitterのAPIを利用してPostmanの基本的な使い方を説明したい。

Postmanとは?

PostmanはAPI開発のために使用されるツール

APIの任意のエンドポイントにHTTPリクエストを送り、レスポンスを受信することができる。

Postmanはウェブの世界では広く普及しており、Webアプリケーションの開発に長く携わっている人であれば、一度は使ったことがあるのでは無いだろうか?

バックエンドエンジニアであれば、自分の作成したAPIが外部からアクセスできるかどうか確かめるために使用する。

フロントエンドエンジニアであればHTTPリクエストにおいてエラーが発生する際に、その原因を確かめるために使うといった用途がおもなユースケースだろう。

なお、現時点ではPostmanの表示言語は英語のみだが、HTTP通信に関する用語はもともと英語がベースなので特に困ることは無いだろう。

PostmanのHTTPリクエストの例

Postmanに含まれるツール

Postmanは大幅な機能拡張をおこなっており、現在ではAPIに関するすべての開発工程をサポートするためのツールを提供している。

Postmanは以下のようなツールを含んでいる。

  • API Client
  • API design
  • API documentation
  • API Testing
  • Mock servers
  • Monitors
  • API detection

この記事では、もっともよく使われるAPI Clientを中心に説明したい。

なお、Postmanには有料の料金プランもあるがAPIのテストのためだけに使用するのであれば無料のプランでも問題ないだろう。

Postmanを使用する準備

Postmanにはオンライン上で使用できるWeb版とインストールして使用するApp版がある。

なお、以前はChromeプラグイン用のPostmanも存在したが現在はサポートは終了している。

*この記事では、App版を使用して説明をおこなうが、操作の内容はまったく同じなのでインストール不要のWeb版を使ってもらって構わない。その場合は、次の「Postmanをインストールする」は読み飛ばしてほしい。

Postmanをインストールする

Postmanのデスクトップ版を使用する場合は以下のページにアクセスしてインストーラーをダウンロードする。

Postman Appダウンロードページ:: https://www.postman.com/downloads

ダウンロードしたファイルを実行するとすぐにインストールが始まる。

インストールは数秒で完了してデスクトップアプリが自動で起動する。

一度、インストールしてしまえば次からは他のデスクトップアプリと同様にインストーラー無しで起動することができる。

Postmanのアカウントを作成する

App版のPostmanはアカウントを作成せずとも一部の機能は使用できるが、出来ればアカウントは作成しておいたほうがいい。

サインアップは以下のURLで済ませることができる。

Postman URL:: https://www.postman.com

Postmanにログインする

アカウントを作成したらPostmanにログインしよう。

App版のPostmanにてSign Inボタンをクリックすると、ブラウザの新しいタブが開くのでEメールとパスワードを入力して「Sign In」をクリックする。

入力内容に間違いが無ければApp版のPostmanにてログインが完了する。

App版でセーブしたリクエストの内容などは、ユーザーアカウントに対して記録される。つまり、Web版のPostmanを使用しても同じアカウントを使用していればセーブした内容はそのまま使用することができる。

Postmanの使い方

では、Postmanの使い方を詳しく見ていこう。

メイン画面の構成

まずはメイン画面の構成を簡単に確認したい。

*Web版とApp版のPostmanのUI構成にはほとんど違いは無い。

  1. ヘッダー部分ではワークスペースを切り替えたり、パブリックのAPIを探したりすることができる。
  2. 画面の左側にはサイドバーがありメニューを切り替えることができる。APIのテストをおこなう場合は「Collections」を選択する。
  3. 中央のエリアがリクエストをおこなったり、レスポンスを確認したりするスペースとなる。
  4. 画面下部にはステータスバーがあり、文字検索をおこなったり、コンソールを使用することができる。

API Networkを使用する

「API Network」は個人や企業が作成したAPIをパブリックAPIとして公開できる仕組みだ。Postmanの使い方を学習しながら、APIの仕組みを理解できるのでぜひ活用してほしい。

この記事では、TwitterのAPIを利用してPostmanの使い方を紹介する。

パブリックAPIを読み込む

まずは検索バーからTwitterのAPIを探して、自分のPostmanアカウントにAPIを読み込む。

画面上部の検索バーを開き「twitter」と入力して「Twitter API v2」を探してクリックする。

PostmanにAPIが読み込まれる。

読み込んだAPIは直接操作することが出来ないので、自身のワークスペース内にフォークを作成する。

サイドバーのコレクション名の横にある設定ボタンから「Create a fork」を選択する。

フォークのレーベル名と保存先のワークスペースを選択して(ワークスペースが無ければ新しく作成する)「Fork Collection」をクリックする。

問題が無ければ自分のワークスペースに「Twitter API v2」が読み込まれる。

トークンを入手する

HTTPリクエストをおこなうためにはトークン(Bearer Token)が必要となる。

Twitterにサインインしたうえで、以下のURLからTwitterのデベロッパーページにアクセスする。

Twitter Developer Platform:: https://developer.twitter.com

トークンを入手するために新しいプロジェクトを作成する。

プロジェクトの名前や説明は適当に入力して問題ない。

プロジェクトを作成すると続けアプリを作成するように促されるので作成する。

アプリの名前を入力した後にAPIキーやトークンが表示される。APIキーやトークンはセキュリティの事情から以降は確認することができない(ただし、新しく生成することは可能)。

「APIキー」「APIキーシークレット」「ベアラートークン」の3つは安全な場所に保存しておくようにしよう。

HTTPリクエストを送信する

では、リクエストをHTTPリクエストを送信してみよう。

ここでは「User Lookup」コレクションの「User by Username」を使用してユーザー情報をAPIから取得してみよう。サイドバーにて「User by Username」をクリックしてリクエストを表示する。

「Authorization」タブを開きタイプとして「Bearer Token」を選択し、先ほどTwitter DeveloperPlatformで入手したBearer Tokenを入力する。

「Params」タブを開き、Path Variablesのusernameに自身のユーザー名を入力して「Send」ボタンをクリックする。Twitterのユーザー名は自身のプロフィールページのURLに表示されている。

問題が無ければ以下のようにユーザー情報がレスポンスとして返ってくるはずだ。

「Ctrl + S」を押せばトークンやパラメーターの内容を含めてリクエストを保存することができる。

Twitter APIの説明はここまでとなるが、他のリクエストもぜひ試してみてほしい。

コレクションを管理する

最後にコレクションの管理について見ていきたい。

ここでは、コレクションのエクスポート・インポートの方法について説明するが、コレクションはチーム内でシェアすることもできる。

他の開発メンバーもPostmanを利用している場合はコラボレーション機能を使いコレクションをシェアしたほうがいいだろう。

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

作成したコレクションはJsonデータとしてエクスポートすることができる。

サイドバーからエクスポートしたいコレクションのメニューを開き「Export」を選択する。

「Export Collection」ダイアログが開くので、Exportをクリックして保存先を指定するとコレクションをエクスポートできる。

コレクションのインポート

コレクションをインポートするには、「File」メニューから「Import」を選択する。

「Import」ダイアログが開くので、ファイルを選択して「Import」をクリックする。