Swift・iOS

Swiftを中心に学んだことを記録に残すブログです。技術に関係ない記事もたまに書いています。

Postmanを試してみる

■はじめに

最近APIを叩くことが度々あるのですが、知り合いのエンジニアの方から「Postman触ってみなよ」とアドバイスいただいたので試してみました。

 

■Postmanとは

OAuth認証 〜 アクセストークン取得 〜 ユーザーの新規登録 〜 ユーザー情報取得 〜 ユーザー情報の更新 〜 ログアウト 〜 ユーザー退会処理 というような一連のAPIの流れを、様々なケースを、状態を維持しながら一度に実行することができます。」 

※引用:[ツール] Postmanを利用したAPIの試験 [機能の紹介] | Developers.IO

 

■試してみる

今回はAIチャットボット作成サービスの「Repl-AI(レプルAI)」のAPIで試してみました。

1.docomo Developer supportのアカウントを登録し、Postmanをダウンロード

無料のAIチャットボット『Repl-AI(レプルAI)』|docomo × インターメディアプランニング

Postman | API Development Environment

 

2.PostmanへKeyやValueを入力していく

Repl-AIにログインすると「sample」というプロジェクトがあるので、このプロジェクトで「ユーザーID取得」を試してみましょう。

 

まず、以下リンクからAPIリファレンスのユーザーID取得に関する概要を確認しましょう。リクエストURLやリクエストヘッダ、リクエストボディなどが書いてあります。これらの内容が正しくリクエストできれば、レスポンスとしてユーザーIDが取得できます。

Repl-AI - ユーザーID取ユーザーID取得|AIチャットボット作成サービス『Repl-AI』

 

それでは、「ユーザーID取得」の概要と「sample」プロジェクトの詳細を見ながら、PostmanへKeyやValueを入力していきましょう。

f:id:hfoasi8fje3:20180604165117p:plain

 

f:id:hfoasi8fje3:20180604173102p:plain

※小ネタ

「リクエストボディ」欄に記載の「リクエスト例」をそのままコピーして、Postmanへペーストすると、ダブルコーテーションの表示が正しくないためエラーになりますのでご注意ください。(この原因に気づけずかなり時間とられました。。)

 

f:id:hfoasi8fje3:20180604170439p:plain

 

■おわりに

GUI上で項目を入力するだけで、欲しい値が正しく出力されるか手軽に確認できるのはとても便利ですね。APIを叩く際には積極的に使っていこうと思います。

 

■関連リンク

Postman | API Development Environment

無料のAIチャットボット『Repl-AI(レプルAI)』|docomo × インターメディアプランニング

spring - Unsupported Media Type in postman - Stack Overflow

[ツール] Postmanを利用したAPIの試験 [機能の紹介] | Developers.IO

APIの開発がむちゃくちゃ捗る「Postman」の使い方 - WPJ

Postmanを使ってWeb APIにアクセスする その1 | SendGridブログ