SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

Developers Summit 2024 Summer レポート(AD)

APIの開発者体験を左右する「Time To First Call」とは? Postmanで実現するAPIファーストな開発

【24-B-8】APIファースト、そしてTime To First Call削減への道筋

  • X ポスト
  • このエントリーをはてなブックマークに追加

 アプリケーション開発において、いまやAPI利用は欠かせないものとなっている。また生成AIの登場により、アプリケーション開発においてもAIの活用も進んでおり、APIの呼び出しも人間がコードを書くのではなく、AI自身が能動的にAPIを理解して呼び出すような流れも始まっている。AIが新しいAPIの使い手となる中で、APIを正しく設計することが求められている。Postmanを使うとどんなことが可能になるのか。APIファーストという考え方の重要性とともに、Postmanが提供する便利な機能などについて、Postman テクノロジー エバンジェリストの草薙昭彦氏が紹介した。

  • X ポスト
  • このエントリーをはてなブックマークに追加

急増するAPI利用、いま注目のAPIファースト戦略とは

 アプリケーション開発において、APIの重要性はますます高まっている。なぜ、API利用が急増しているのか。「その要因は3つ考えられる」と草薙氏。第1にユーザーのアプリケーションの利用がデスクトップからモバイルへと変わったこと。第2にアーキテクチャがモノリスから複数のモジュールが相互に通信するマイクロサービスへと変わったこと。第3にインフラがオンプレミスからクラウドに移行したことが挙げられる。

 APIを取り巻く変化はこれだけではない。「APIの新しい使い手が増えてきたことも大きな変化」と草薙氏は言う。APIの利用が始まった当初の主な利用者はeコマース事業者だった。しかしソーシャルネットワークが登場し、クラウドが主流になり、さらにモバイル、IoTが登場すると、使い手の中心は人が書いたプログラムとなった。さらに「今やAIが能動的に、どんな機能のAPIがあるのかを理解し、AI自身が呼び出して使うという時代になっています」と草薙氏は言う。つまりサービス提供者は、APIを正しく作らないと、AIとの連携が難しくなる。「このようにAPIに対する考え方が変わってきているのです」(草薙氏)

Postman株式会社 テクノロジー エバンジェリスト 草薙 昭彦氏
Postman株式会社 テクノロジー エバンジェリスト 草薙 昭彦氏

 そういった状況のなか、PostmanではAPIファースト戦略を提唱している。どのようなものか。「APIはインタフェースだが、それ自体がプロダクトという位置づけであり、APIを中心に自分たちのビジネスやサービスを考えていくこと。つまりAPIファーストは技術よりもビジネスや会社の戦略を取り込みながらAPIを考えるアプローチです」と草薙氏は説明する。

 そしてAPIファースト戦略は、APIファースト開発モデルというAPIを主軸に開発の中で取り扱っていくという技術的な要素はもちろん、APIファーストを採用した企業がAPIを継続的に改善していくため、保守・運用のためのチーム体制を構築するという要素も求められる。

 同社では毎年、大規模なアンケートを実施している。APIファーストでAPIを開発するメリットについて尋ねると、「パートナー連携が早い」「オンボードが早い」「生産性が高い」というメリットを挙げる人が多かったという。ちなみにオンボードが早いとは新しく開発チームに加わる人がターゲットのシステム開発に素早く取り組めることである。

 APIファースト開発モデルの焦点は、最初にAPIの設計をしっかりしておくことだという。そして設計したAPIを、すべてのチームの中でコントラクト(契約)という形で全員が意識して、コードを書く前にAPIを設計・構築し、モック、ドキュメント、テストも作成する。「こうすることで、仮で動くモックサーバーを稼働状態にしておくと、モバイルのフロントエンドの開発をしながら、同時にドキュメントやテストも書くことができるなど、効率的な開発が実現します」(草薙氏)

APIファースト開発モデル
APIファースト開発モデル

APIを評価する重要な指標「TTFC」とは

 API利用には障壁があるという。先に紹介したアンケートによると、API利用による障壁として、「ドキュメント不足」「APIの発見が困難」「時間がない」という回答がトップ3を占めた。「ドキュメントが不足すると、どういう動作をするのか分からない、どういう使い方をすればよいのかが分からない。また誰かがAPIを作っても、どこにあるか探しても見つからないとやはり使われない。APIをしっかり使って開発する時間も無い。そういう課題がAPI利用にはあります」と草薙氏は説明する。

 APIを使って開発する指標にはさまざまなものがある。その中で草薙氏が最も重要と捉えているのが、Time To First Call(TTFC)である。TTFCはどれだけ短時間でAPIの初回呼び出しができるかを表すメトリクス。「開発者体験に関する指標」と草薙氏は語る。

APIに関する指標の例
APIに関する指標の例

 API提供者はTTFCを分析してAPIの導入プロセスを改善し、その短縮を目指すことが求められる。具体的にはAPIを説明しているWebページの訪問やサインアップを起点に、最初のAPIコールまでの時間を測定する。Webサイトの閲覧からサインアップまでの時間がかかっているのであれば、Webサイトやドキュメントの品質に起因する可能性が考えられる。一方、サインアップから最初のAPI呼び出しまでに時間がかかっているのであれば、ガイドページの有効性や製品の使いやすさに起因する可能性があるというわけだ。

 一般的に、多くの開発者は実際にAPIを使うことで、その機能の中身を理解し納得する。つまり開発者にとってファーストコールは重要なものだが、それ以前に離脱する様なことがあれば、活用される機会を逃すことになる。「TTFCを短縮することで、より幅広い開発者に自分たちのサービスを理解してもらえるようになる。だからTTFCは重要な指標なのです」(草薙氏)

 TTFCはパブリックなAPIに限ったものではなく、社内向けのAPIにおいても重要な指標だという。

 ではどのくらいのTTFCが適切なのか。「一概には言えないが、頑張って取り組んでいる企業は数分レベル」と草薙氏は言う。

 TTFCを改善する施策の第1は優れたドキュメントを用意すること。必要な情報をもれなく盛り込むことが重要だ。第2にユースケースやサンプルを用意すること。利用者の抱える課題に対する正しい解決策かどうかを明確にするためだ。第3にプロセス上の障害を排除すること。認証情報の取得は避けられないが、その情報の準備にかかる時間やプロセスをできるだけシンプルにする必要がある。

 第4に早い段階でAPIコールできる工夫をすること。「例えばサンドボックスを用意するのもその一つ。自由に試せる環境をあらかじめ用意しておくことで、機能を素早く理解してもらうことができます」(草薙氏)第5は外部ツールの利用。「APIプラットフォーム製品やノーコード/ローコードツールを使うことも、TTFC改善のアプローチの一つです」(草薙氏)

Postmanが提供する、TTFC低減に効く2つの機能

 この第5のアプローチとして活用できるのが、Postmanである。Postmanは当初、APIクライアントツールという位置づけだったが、今ではAPI開発に関わる、さまざまな便利な機能を有したプラットフォームへと発展している。

 「Postmanは、2023年4月より日本にオフィスを構えて活動しており、2023年秋にはPostmanの日本語化も行い、日本語に切り替えるスイッチも用意している。使いやすくなると思うので、ぜひ試してほしい」(草薙氏)

 Postmanが提供する特徴的な機能も紹介された。その一つが「コレクション」だ。コレクションはAPIリクエストをグループにして整理した、基本となるデータ構造。「私たちは実行可能ドキュメントと呼んでいるように、単なるデータの格納形式ではなく、APIの呼び出しとドキュメントをセットで保存しておける機能です。つまりAPIの理解と実行が一体化したもの」と草薙氏は説明する。

Postmanコレクション(実行可能ドキュメント)とは
Postmanコレクション(実行可能ドキュメント)とは

 またPostmanでは「APIネットワーク」というカタログ機能も用意している。これはパブリックAPIネットワークという全世界の利用者・開発者が見られるカタログ機能だけではなく、プライベートAPIネットワークという自社内に閉じたクローズドなカタログとしても利用することができる。カタログを用意しておくことで、「APIの発見が困難」というAPI利用の障壁を軽減することができる。「コレクションとカタログはいずれもTTFCを短縮するための便利な機能です」(草薙氏)

 APIネットワークは、誰でも作ったAPIを登録することができるという。「日本では初めてfreeeさんが公式APIとして登録され、ブルーバッジを獲得しました。自社のAPIを公開して、なるべく多くの人に使ってもらいたいと考えている方がいらっしゃれば、ぜひ、私たちに相談してください。スムーズにカタログに載せられるようにサポートします」(草薙氏)

 現在、Postmanでは無料で試せるデスクトップアプリやWebアプリを提供している。またAPIを利用者や開発者が日本語で交流するための場、「Postman Japanコミュニティ」Discordサーバーも開設。「Postmanに関する技術的な疑問や質問にも、回答してくれる人たちが集まっています。ぜひ、こちらにも参加してください」と語り、セッションを締めた。

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加

提供:Postman株式会社

【AD】本記事の内容は記事掲載開始時点のものです 企画・制作 株式会社翔泳社

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/20087 2024/09/17 12:00

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング