Postman で Momento が Verified API Provider に認定にされました
先日Xでこのようなアナウンスがされました。
Postmanの認定APIサービスプロバイダーとして認定されたとのことです。
と、いうことで今日はPostmanからMomentoを触っていきたいと思います。
Postman とは
Postmanは、APIの開発・テスト・管理を効率化するためのツールです。APIリクエストを作成し、そのレスポンスを確認する機能を提供します。ユーザーはリクエストの種類（GET、POST、PUT、DELETEなど）を選択し、パラメータやヘッダーを設定できます。また、テストスクリプトの実行や、レスポンスの自動化テストもサポートしており、API開発の効率を大幅に向上させます。最近ではPostman Flows というステートマシンによりワークフローをクラウド上で実行させる機能も備わっています。
Postman Verified 
このマークがついているAPIはPostmanにより検証・認定されたAPIであることを意味します。
認定されたAPI提供事業者は、特定の URL または URL セットによって提供される API の正式な所有者であることを Postman が確認したことを意味します。また提供されるドキュメントは公式であることが保証され、対象サービスの学習開始地点として質の高いコンテンツが提供されることが保証されています。
例えば、新しいAPIを検証したいとします。公式ドキュメントはAPI提供事業者のウェブサイトに存在しており、そのドキュメントを読みながら、リクエストに必要なヘッダーやボディの構造を把握し、リクエストを実行させるJSONパラメータなどを構築して初めてAPIの呼び出しを行うことが可能となります。Postmanにより認定されたAPIサービスプロバイダーは、公式のドキュメントとすぐにAPI呼び出しが可能となるGETやPOSTのJSONパラメータなどが準備されているため、最小の学習コストでAPIの利用開始が可能となり、結果として開発生産性を向上させます。
さっそくやってみる
Postmanのワークスペース（管理者画面）でmomentoと検索すると以下の通りMomentoのAPI群が認定付きブルーバッジと共に表示されます。
ダブルクリックを行うと以下のようにMomento専用ワークスペースに画面が切り替わります。そして左ペインに主要なAPIコールがあらかじめひな型としてセットされていることがわかります。
HTTP APIをフォークしてみます。
自分の作業環境ワークスペースにコピーが作成されます。
Create itemを選んでみるとあらかじめAPIコールが設定されていることがわかります。
{{BASE_URL}},{{cacheKey}},{{timeToLiveSeconds}},{{cacheName}}という４つの変数が存在しておりこちらを実際の環境に合わせてセットします。
どれかの変数をクリックしてAll variablesをクリックします。
ここに実際の値を入れていきます。
各変数に必要な値はこちらで定義されています。
東京リージョンの場合以下の値になります。
BASE_URL:https://api.cache.cell-ap-northeast-1-1.prod.a.momentohq.com
cacheName:default-cache
cacheKey:test
timeToLiveSeconds:300
以下が戻ってくるはずです。
{
"status": 401,
"title": "No Auth Token Provided",
"detail": "You must provide a valid momento auth token via the 'Authorization' header or the 'token' query parameter."
}
Tokenをセットさせるためには次にSuccessをクリックします。
MOMENTO_AUTHに先ほどと同じ手順でAPIKEYを設定します。
実行すると204 No Contentが戻るはずです。トークンが正しくセットされたため"No Auth Token Provided"エラーが出なくなっています。
キャッシュのキーtestに呼応する値はリクエストボディに書き込まれています。
Momentoのマネージメントコンソールから値が正しく格納されていることが確認できます。
いかがでしょうか。仮に初めてMomentoのHTTP APIに触れる場合、必要とされるURLパラメータやJSONの構造を理解したうえでリクエストを組み立てるのは時間のかかる作業ですが、PostmanのVerifiedされたワークスペースを使うことでこのように簡単にAPIのテストが行えます。
Discussion