APIという言葉は知っていましたが、具体的にどんなものなのかはわからない。。。
そんな私が初めてPostmanを使ってみました。
その際の忘備録を書いてみます。
まずはこのスライドを読みました。
https://speakerdeck.com/rnakamuramartiny/lobal-microsoft-365-developer-bootcamp-2019-tokyo-microsoft-graph-api
ふむふむ。。。明示的にHTTPメソッドを使用する。。。
今回はMicrrosoft Azure Face のAPIをPostmanを使ってAPIをテストしてみました。
Postmanをインストールする
Postman
公式サイトからアプリをダウンロード、インストール。
メールアドレス、またはGoogleアカウントを使いアカウント作成を行います。
Collectionを作成する
作成するテストをまとめておくCollectionを作ります。
Requestを作成する
HTTPメソッドには種類がある
プルダウンを見るといろんな種類がありますが、
- GET:データの取得
- POST:データの送信（新規作成)
- PUT:データの送信(置き換え)
- PATCH:情報を更新
- DELETE:情報を削除
をまず把握しました。
試しにMicrosoft Azure Face の PersonGroupを作成してみる
Person Group - Create
APIの仕様を確認。
- HTTPメソッドは PUT
- メソッドを送信するURLは
{Endpoint}/face/v1.0/persongroups/{personGroupId}
なのでこのように、設定。
何もわからずどハマりした箇所
Postmanで自動生成されるHeader情報をオフにしないこと。
仕様を確認した上で
Headerに入れるKEYとVALUEを入力。
Acceptキーには、application/json を、
Ocp-Apim-Subscription-Key キーには、Azure で作成したFace のサブスクリプションキーを入力。Bodyに入れるJSONの記述を入力。
Bodyはrawを選択。
Sendボタンをクリック
これで作成！
GETメソッドで作成できているか確認する
Person Group - Get
APIの仕様を確認。
Person グループ名、userData、および認識 Itionmodel を取得します。
- Body は noneに設定
Sendボタンをクリック
先ほどPUTメソッドで作成した PersonGroupが表示されていました。
まとめ
私は普段バリバリコードは書きませんが、PostmanはGUIでAPIのテストを行うことができ、非常に便利なツールである事がわかりました。
これをきっかけにAPIについてもっと深めてみようと思います！