Postman

[Postmanの機能]

API Client：公開されているもしくは開発中の各種APIを簡単にテストできる機能

基本的な手順

1. 右の欄にAPIをテストするURL（Base URL＋対象のResource）を指定
2. リクエストメソッドをドロップダウンから選択
3. Paramsタブの【KEY】と【VALUE】にクエリ文字列を指定
   →自動的にURIへQueryが補完
   ※チェックボックスのチェックを忘れるとクエリ文字列がURLに反映されない
4. 【Send】ボタンを押す
   →Bodyにレスポンスが返ってくる

Automated Testing：API開発者向けに各エンドポイントに対する自動テスト機能

Design & Mock：APIを開発するにあたって、API SchemaをDesignするための専用EditorとそれをテスティングするためのMock Server機能

Documentation：PostmanのAPI定義から自動的にAPIドキュメントを生成し、外部ユーザーに提供することができる機能

Monitors：提供されているAPIを定期的にチェックし、APIのアップデートや変更に伴う破損や従来のエクスペリエンスに変化が無いかモニタリングする

Workspaces：チームでAPIを共同開発するためのコラボレーション機能

[Web APIに関する７つの要素]

Web APIはRESTという設計思想に基づいている

• Base URI
  Web APIを提供しているサービサーのURIエンドポイントを特定する
• Resource
  どんなデータを操作するのかを決める
• Method
  HTTPの原則に基づいて、GETやPOST・PUT・DELETEといったリソースに対する操作方法を指定
• Query
  主にデータを取得する際の各種諸条件を適用するために使われるパラメータセット
  URLクエリ文字列、URIパラメータ、Query Stringなど様々な呼び方がある
  QueryまたはQuery String（クエリ文字列）が正式な呼称
• Authentication
  Web APIを操作するための認証機能がデフォルトで備わっている
  ※Basic認証を使用する際は認証のTypeから「Basic Auth」を選択し、UsernameとPasswordを入力
• Header
  対象のAPIに対して、追加情報を渡すために使用されるプロパティセット
  認証情報やどんなフォーマットでデータの受け渡しを行うのかを指定する
• Body
  Web APIに渡すためのメインとなるデータを指定するための要素

参照：
https://kageura.hatenadiary.jp/entry/hazimetepostman