【超初心者向け】これだけは知っとけPostman
「APIもPostmanもよく分からないけど連携確認するよう言われた」という右も左も分からない方向けの記事です。
要約
以下の手順でAPIテストをすることができる
1.パブリックワークスペースで公式が提供するワークスペースを検索
2.マイワークスペースにフォーク
3.各種設定のうえAPIリクエストを送信
Postmanって何？
APIの開発とテストを支援するツールです。
他のAPIプラットフォームと比べ、多機能かつ直感的に操作できることが利点として挙げられます。
APIって何？
とりあえず最初は「別々のシステムを連携させる技術なんだなぁ」くらいの理解で良いかと思います。
もっと説明するなら「Application Programming Interface」の略で、「アプリやソフト同士（Application）がプログラムによって（Programming）情報のやり取りをする接続部分（Interface）」となります。
APIを使用した身近な例としてはSNSでのbotが挙げられます。
最近Xでインプレゾンビを見かける方も多いと思いますが、あれもAPIを使って自動投稿しています。
さらに最近はChatGPTのAPIも併用することで、より人間らしい投稿をするゾンビが出来上がりつつあります。
最低限おさえておくべき用語
この先の説明でも出てくるので、もし分からなくなったらこちらの説明を参考にしてください。
- 認可：認証済みユーザがアクセスすることを許可するプロセス
- 認証：ユーザが誰であるかを確認するプロセス
- ヘッダー：認証/認可情報や送信するデータのタイプ（JSON/XMLなど）を指定する部分
- ボディ：リクエストで送信するデータを入れる部分
- HTTPメソッド：リクエストを指定するために使用するもの。GET/POSTなどがある
- エンドポイント：特定のデータや機能にアクセスするためのURL
- パラメータ：リクエストのカスタマイズに使用
- リクエスト：APIに対してこちらから行なう指示
- レスポンス：リクエストに対するAPIからの返答
0.初回のみ対応
デスクトップアプリとWebアプリがあります。今回はWebアプリを使用します。
1.WebアプリのURLにアクセス
初めての方は「Sign Up for Free」からアカウントを作成してください。
https://www.postman.com/
2.日本語化
歯車マーク > Settings > General > Application > Language から日本語を選択してください。
1.パブリックワークスペースを開く
「ワークスペース」とは名のとおり作業場です。このなかに関連するリクエストが取りまとめられています。
SalesforceのAPI環境を例に説明を進めていきます。
検索窓に「Salesforce」と入力し、「Salesforce Developers」を選択します。
※存在しない場合は自分でワークスペースを作っていくことになります。初心者には難しいので先輩や上司に相談しましょう
ワークスペースを開くと、「コレクション」と呼ばれるAPIリクエストの一覧があります。
キャプチャの「POST SOAP Login」のところがリクエスト、「e.g. Successful SOAP Login」のところがAPI実行例となります。
また、右サイドバーの「コードスニペット」にて、リクエスト時のコードを確認することも可能です。
2.マイワークスペースにフォーク
「マイワークスペース」は自分だけがアクセスできる作業場です。
パブリックワークスペースでリクエストを送信しようとしたら以下のような表示が出るので、素直に「フォークを作成」を選択します。
以下の画面に遷移するので、「コレクションをフォーク」を選択します。
My Workspaceのなかにコレクションが生成されます。
無事「送信」が使えるようになりました。
3.各種設定のうえAPIテスト
あとは各タブや変数を設定していきます。
設定内容は使用するAPIによるので、e.g.や公式ドキュメントを参考にしてください。
パラメーター
リクエストをカスタマイズするためのパラメータを設定します。
チェックを付けたパラメータはURLに反映されます。
逆にURLに記述した場合はこのタブに自動反映されます。
認可
API連携に使用する認証方法を設定します。
「上位の認可設定を継承」を選択すると、ツリー上位で設定した認可設定を使用することができます。リクエストごとに認可設定するのが面倒な場合に役立ちます。
ヘッダー
後述のボディに渡すデータのタイプなど、ヘッダー情報を設定します。
ボディ
リクエストの際にこちらから渡すデータを設定します。
その際のデータはヘッダータブで指定したContent-Typeに沿ったものとします。
変数
{{変数名}}となっている箇所を「変数」と呼んでいます。
変数を使うことで、Postmanに値を保存して再利用することができます。
変数は「環境」機能で管理します。
サイドバー > 環境 > 環境を作成
各項目に値を入れていきます。
- タイプ：パスワードなど機密データの場合は「シークレット」を選択
- 初期値：Postman のサーバーに同期される。その要素を共有するときにチームと共有される。チームメイトと共同作業するときに役立つ。
- 現在値：ローカル値であり、Postman のサーバーとは同期されない。
個人利用するだけならあまり気にせず初期値と現在値は同じ値にしてよいと思います。
右上のプルダウンから作成した環境を選択します。
{{url}}にマウスを置くと、設定した初期値と現在値が反映されていることを確認できます。
ここまで設定ができたらあとは「送信」を押下してレスポンスを確認します。
Discussion