経験者向け今回はウェブ開発者の定番ツールであるPostmanについて初めて使う人向けに解説していきたい。Postmanは簡単に言うとAPIのテストをおこなうためのツールで、手早くHTTPリクエストを送信してエンドポイントが正しく機能しているか確認することができる。Webアプリケーションの制作に携わる人であれば、一度はお世話になるツールなのでぜひ使い方を覚えておきたい。この記事ではPostmanの特徴や使い方はもちろん、TwitterのAPIを利用したPostmanの使用例を紹介しているのでぜひ参考にしてほしい。コレクションのインポートPostmanとは?PostmanはAPI開発のために使用されるツール。APIの任意のエンドポイントにHTTPリクエストを送り、レスポンスを受信することができる。Postmanはウェブの世界では広く普及しており、Webアプリケーションの開発に長く携わっている人であれば、一度は使ったことがあるのでは無いだろうか?バックエンドエンジニアであれば、自分の作成したAPIが外部からアクセスできるかどうか確かめるために、フロントエンドエンジニアであればHTTPリクエストにおいてエラーが発生する際に、その原因を特定するために使うといった用途が考えられる。現時点ではPostmanの表示言語は英語のみだが、HTTP通信に関する用語はもともと英語がベースなので特に困ることは無いだろう。PostmanのHTTPリクエストの例Postmanに含まれるツールPostmanは大幅な機能拡張をおこなっており、現在ではAPIに関するすべての開発工程をサポートするためのツールを提供している。Postmanは以下のようなツールを含んでいる。Clientを中心に説明したい。Postmanには有料の料金プランもあるがAPIのテストのためだけに使用するのであれば無料のプランでも問題ないだろう。Postmanを使用する準備Postmanにはオンライン上で使用できるウェブ版とPCにインストールして使用するアプリ版がある。以前はChromeプラグイン用のPostmanも存在したが現在はサポートを終了している。*この記事では、アプリ版のPostmanを例に解説をおこなうが、操作の内容はまったく同じなのでインストール不要のWeb版を使ってもらって構わない。その場合は、次の「Postmanをインストールする」は読み飛ばしてほしい。PostmanをインストールするPostmanのアプリ版を使用する場合は以下のページにアクセスしてインストーラーをダウンロードする。https://www.postman.com/downloadsダウンロードしたファイルを実行するとすぐにインストールが始まる。インストールは数秒で完了してデスクトップアプリが自動で起動する。一度、インストールしてしまえば次からは他のデスクトップアプリと同様にインストーラー無しで起動することができる。Postmanのアカウントを作成するアプリ版のPostmanはアカウントを作成せずとも一部の機能は使用できるが、出来ればアカウントは作成しておいたほうがいい。サインアップは以下のURLで済ませることができる。https://www.postman.comPostmanにログインするアカウントを作成したらPostmanにログインしよう。In」をクリックする。入力内容に間違いが無ければPostmanへのログインが完了する。アプリ版にてセーブしたリクエストの内容などは、ユーザーアカウントに対して記録される。同じアカウントを使用していればウェブ版のPostmanでもセーブした内容はそのまま使用することができる。Postmanの使い方では、Postmanの使い方を詳しく見ていこう。メイン画面の構成まずはメイン画面の構成を簡単に確認したい。*ウェブ版とアプリ版のPostmanのUI構成にはほとんど違いは無い。ヘッダー部分ではワークスペースを切り替えたり、パブリックのAPIを探したりすることができる。画面の左側にはサイドバーがありメニューを切り替えることができる。APIのテストをおこなう場合は「Collections」を選択する。中央のエリアがリクエストをおこなったり、レスポンスを確認したりするスペースとなる。画面下部にはステータスバーがあり、文字検索をおこなったり、コンソールを使用することができる。Network」は個人や企業が作成したAPIをパブリックAPIとして公開できる仕組みだ。Postmanの使い方を学習しながら、APIの仕組みを理解できるのでぜひ活用してほしい。この記事では、TwitterのAPIを利用してPostmanの使い方を紹介する。パブリックAPIを読み込むまずは検索バーからTwitterのAPIを探して、自分のPostmanアカウントにAPIを読み込む。v2」を探してクリックする。PostmanにAPIが読み込まれる。読み込んだAPIは直接操作することが出来ないので、自身のワークスペース内にフォークを作成する。fork」を選択する。Collection」をクリックする。v2」が読み込まれる。Token)が必要となる。Twitterにサインインしたうえで、以下のURLからTwitterのデベロッパーページにアクセスする。https://developer.twitter.comアクセストークンを入手するために新しいプロジェクトを作成する。プロジェクトの名前や説明は適当で問題ない。プロジェクトを作成すると続けてアプリを作成するように促されるので作成する。アプリの名前を入力した後にAPIキーやトークンが表示される。APIキーやトークンはセキュリティの事情から以降は確認することができないので注意する。(ただし、キーやトークンを新しく生成することはできる)「APIキー」「APIキーシークレット」「ベアラートークン」の3つは安全な場所に保存しておくようにしよう。HTTPリクエストを送信するでは、リクエストをHTTPリクエストを送信してみよう。Username」を使用してユーザー情報をAPIから取得してみよう。Username」をクリックしてリクエストを表示する。Tokenを入力する。Variablesのusernameに自身のユーザー名を入力して「Send」ボタンをクリックする。Twitterのユーザー名は自身のプロフィールページのURLに表示されている。問題が無ければ以下のようにユーザー情報がレスポンスとして返ってくるはずだ。S」を押せばトークンやパラメーターの内容を含めてリクエストを保存することができる。APIの説明はここまでとなるが、他のリクエストもぜひ試してみてほしい。コレクションを管理する最後にコレクションの管理について見ていきたい。ここでは、コレクションのエクスポート・インポートの方法について説明するが、コレクションはチーム内でシェアすることもできる。他の開発メンバーもPostmanを利用している場合はコラボレーション機能を使いコレクションをシェアしたほうがいいだろう。コレクションのエクスポート作成したコレクションはJsonデータとしてエクスポートすることができる。サイドバーからエクスポートしたいコレクションのメニューを開き「Export」を選択する。Collection」ダイアログが開くので、Exportをクリックして保存先を指定するとコレクションをエクスポートできる。コレクションのインポートコレクションをインポートするには、「File」メニューから「Import」を選択する。「Import」ダイアログが開くので、ファイルを選択して「Import」をクリックする。執筆者:久野嘉樹ドイツ・ベルリン在住のフロントエンド・エンジニア。ドイツにてプログラマのための職業訓練プログラム(インターン2社を含む)を終了したのち、医療関係のソフトウェア会社にてフルスタック・エンジニアとして、様々な開発現場に参加する。現在はドイツの大手SIerにてシニアデベロッパーとして有名企業を顧客とする大規模開発に従事する。Java・TypeScriptをメインに業務管理ソフト・ウェブアプリケーションやAndroidアプリなどの開発経験を持つ。現在はSPA(シングルページアプリケーション)のスペシャリストとしてAngularをメインにフロントエンドの開発に携わる。2009年よりドイツに在住。ドイツ語能力はC1レベル。Workerとは何か?仕組みと出来る事をわかりやすく解説。Workerについてその仕組みや出来ることを中心に解説したいと思う。Token)とは?トークンのデータ構造と暗号化の仕組み。Token(以下JWT)について説明する。JWTは特にウェブの世界を中心[...]シングルページアプリケーションとは?従来のWebサイトとの違いとメリット。【2023年】TypeScriptのおすすめ書籍5冊!レベル別に入門書からプロ向けまで紹介。2023.05.14【2023年】JavaScriptのおすすめ本7選!入門者・初心者向けにセレクト。2023.03.04HTMLテーブルで表をデザインする!セルの結合・枠線を付ける・レスポンシブ対応など。2023.01.21CSSグリッドレイアウトを極める!基本的な使い方とプロパティの一覧。2023.01.07【2023年】人気のヘッドレスCMSを徹底比較!Contentful・Strapi・Hygraphなど。JSフレームワーク徹底比較!JavaScript実践VSCodeでReactの開発を行う!React開発者のためのオススメ拡張機能。同一オリジンポリシーを理解する。APIコラム海外エンジニアエンジニア論PC。