Zenn
🙌

パブリックなAPIは、"すべて"
Postman API Networkで公開してくれないか!

2023/12/06に公開
API
Postman
cache
momento
tech

概要

  • 先日(2023/12/5)に行われた、Postman 日本上陸記念イベントにてLTをさせていただきまして、その内容についてをブログ化しようと思い書かせていただきました。

https://www.postman.com/jp/events/postman-japan-launch/

https://speakerdeck.com/yoshiitaka/paburitukunaapiha-subete-postman-api-networkdegong-kai-sitekuree

Momentoが提供するサービス

  • Momento というサービスでは、PostmanのパブリックAPIネットワークに公開しているAPIの情報をドキュメントと共に掲載させていただいております。

  • なぜSaaSのサービスがパブリックのAPIをPostmanに登録したのか、そんな内容を今回はお届けし、パブリックなAPIがあるサービスを持たれている会社さんは是非、Postman APiネットワークにてAPIを公開することを検討いただけると幸いです。

  • Momentoでは、現在4つのサービスをユーザへ提供し、そのどれもでユーザが使えるAPIを公開、簡単に利用ができるように作成されています。

Momento Chache

  • キャッシュのユースケースを考えたときに、よくみなさんデータベースとバックエンドサービスの間で使用し、データベースに対する負荷を軽減し、サービス全体の速度を向上させるために使用しているのではないかなと思っています。
  • Momento Cacheでは、このキャッシュの部分をVPCやコスト、維持などを考えることなく、API Keyを払い出し簡単に使えるそんな機能として提供しています。
  • 驚くはその速度で、この辺りの内容は公式ブログでもユーザさんが書かれたブログでも公開されているので、性能面についてはそちらをご参照ください。

Momento Topics

  • Momento Topicsは、簡単にいうとPub/Subの機能です。
  • Pub/Subでよく使われるサービスとしては、リアルタイムチャットなんかが挙げられるんじゃないでしょうか。
  • 1人がメッセージを送り、そのメッセージをサブスクライブしている側が通知を受け取り、メッセージを受け取るそんな動きとなります。

Momentoでは、これらの機能をAPIとSDKとして提供しており、ユーザはAPI Keyさえ払い出せればすぐにでも使うことができる、そんなサービスとなっています。

Momentoのワークスペース

Momentoでは、上記のようなAPIをPostmanのパブリックAPIネットワークにて提供しております。
なぜ公開しているのかというと大きく分けて2つあるんじゃないかなと思っています。

  • 公開しているAPIの検証を短時間でできる。
  • APIを叩く際に設定しなければいけない変数など何が必要かがビジュアライズされていて使いやすい

Postman APIネットワークとは?

ちなみにここで出てくるPostman APIネットワークというのは、ワークスペースを通じた”共有”と”コラボレーション”を社内だけではなく、パートナー、社外に対してAPIの共有、共同作業を実現するための機能となっています。現在ですと下記のネットワークが選択できます。

  • パブリックAPIネットワーク
  • プライベートAPIネットワーク

パブリックAPIネットワーク

今回お話ししているのは、上記のうちパブリックAPIネットワークに関しての内容について触れています。
パブリックAPIネットワークとは、利用者に公開されているAPIが含まれるパブリックAPI成果物のカタログ。
ワークスペースを通じて、APIを共有することができるのです。

  • パブリックなAPIを世界中の利用者に簡単に公開。フォードバックをもらえる
  • 利用者の”Time to first call”の短縮化

何が嬉しいのか？

今までは・・？

  • SaaS側としては、利用者にドキュメントを読み検証してほしいが、ドキュメントは複雑化し機能を試すまでに時間がかかってしまう。
  • フィードバックをもらうために、直接利用者の声を聞く必要がある。

Postman パブリックAPIネットワークを使うと・・？

  • APIを叩くために簡単なドキュメントを記述することができる
  • 認証に必要な情報をまとめ、変数を用意できる
  • 世界中の開発者からフィードバック、目に留まる。

Time to First Callとは?

ちなみに、Time to First Callとは、どれだけ短時間でAPIの初回呼び出しができるかを表すメトリクスを指しています。

  • とあるAPIを発見したときに、発見時点(Webサイトへの訪問や
サインアップなど)から、最初のAPI呼び出しまでの時間差のことです。

Momento APIをPostmanワークスペースから叩いてみた

Momentoでは、APIの認証に個人で払い出したAPI Keyを利用します。
驚くはそのAPI Keyを払い出すまでの時間で超短時間で作成ができます。

Momento Cache Put API

  • あとは簡単で、API Key, Cache Name, Key Name, Valueを設定し、叩くだけです。

Momento Cache Get API

  • こちらも同様ですね。API Key, Cache Name, Key Nameを設定し、叩くだけです。

まとめ

  • SaaS製品で気軽に開発者に体験をさせたい場合に、Postman API ネットワークへのAPI公開を検討してみるのはいかがでしょうか。
  • 公開することによって、TTFC(Time to First Call)を短縮し、より開発者フレンドリーな体験を提供することができると思います。

Discussion