「API仕様」の新たな常識
マイクロサービスの次なるステップ? 「API設計ファースト」で変わる開発現場
アプリケーション開発において、マイクロサービスアーキテクチャの次の波と見られているのが「API設計ファースト」という考え方だ。あるアプリケーションベンダーが実践する開発手法や使用ツールを紹介する。
アプリケーション開発において、「マイクロサービスアーキテクチャ」が普及している。これは、ビジネスロジックごとにそれぞれ独立したサービスを開発し、それらをAPI(アプリケーションプログラミングインタフェース)で連携させることで1つの大規模なアプリケーションを構築する手法だ。このマイクロサービスアーキテクチャからさらに一歩進んだ手法として、「API設計ファースト」がある。どのような手法なのか。実際の採用例と併せて紹介する。
開発手法“API設計ファースト”とは何か? そのメリットは
イリノイ州シャンバーグに拠点を置く、人事(HR)・給与・経費管理ツールベンダーPaylocityは、1997年に設立された。2000年代中頃、当時としては先進的だったが、異なるサービスを組み合わせてシステムを構築する「サービス指向アーキテクチャ」(SOA)を自社製品に採用した。現在、同社はそれを新たにマイクロサービスアーキテクチャに置き換える作業を進めている。特定のイベントをトリガーにしてプログラムを自動実行する「イベント駆動型プログラミング」も採用しており、各サービスが他のサービスのイベントに応答して動作する仕組みだ。
以前はサービス間の通信にメッセージングツール「RabbitMQ」を使用していたが、SaaS(Software as a Service)連携ツール「AWS EventBridge」に置き換えた。Paylocityのアプリケーションの中核システムの一部はまだ移行の途上にある。
APIを利用するリクエストを制御する仕組み「APIゲートウェイ」も刷新した。Nevatechの「Sentinet」からコンテナオーケストレーションツール「Kubernetes」ベースの「KrakenD」に置き換え済みだ。現在はAPIのガバナンス強化に取り組んでいる。
2025年5月、Paylocityのプリンシパルエンジニアを務めるベン・ヘイル氏は、米国Informa TechTargetのインタビューに答え、次のように語った。「アプリケーション業界において、開発プロセスの革新に終わりはない。私たちの当面の目標は、今後数カ月で、APIゲートウェイのモダナイゼーション(最新化)を完了させることだ。鍵となるのが“API設計ファースト”という原則だ」
「具体的には、各サービスのソースコードを記述する前に、『API仕様』(API Specification、API定義とも)を作成するよう社内ルール化した」と、同氏は説明する。
「このためにKrakenDの商用版『KrakenD Enterprise Edition』を導入した。KrakenD Enterprise EditionはAPI仕様として『OpenAPI Specification』(OAS)をインポートできる。API仕様により、APIの構造とセマンティクス(意味)を人間とコンピュータの両方が容易に理解できるようになり、アプリケーションの開発と改良に役立つ。これがAPI設計ファーストであり、わが社のエンジニア1000人にとっては開発手法の大きなシフトだった」。ヘイル氏はそう語る。
「以前のAPIゲートウェイでは、開発チームがソースコードに『APIフック』(APIの動作を操作するプログラム)を埋め込み、そこからAPI仕様を生成していた。APIゲートウェイはそれに基づいてAPIリクエストを制御していた。今はその逆で、最初にAPI仕様を作成する。完成を受けて、初めて開発者はソースコードを書き始めて“よし”となる」(ヘイル氏)
このアプローチにより、Webアプリケーションやモバイルアプリケーションを担当するフロントエンド開発者は、バックエンドエンジニアがAPIを完成させるのを待つことなく、API仕様に基づいてコーディングを開始でき、開発の自由度が高まる。これはマイクロサービスアーキテクチャへの移行にも役立ち、サードパーティーのAIエージェントからのAPIリクエストを管理する基盤ともなる。全てがAPI設計ファーストというわけだ。
API設計ファーストの実現に役立つツール
しかし、API仕様のファイルを頻繁に使用するのは、特定のタイプのAPIリクエストをグループ化して管理する「APIコレクション」での作業に慣れた開発者にとって困難な場合がある。
「データ記述言語『JSON』形式で記述された、6万3000行にも及ぶAPI仕様ファイルを手動で更新するのは楽しい作業ではないし、役立つ管理ツールも少ない。一部のツールは読み取り専用で、インタラクティブ性やコラボレーション機能に欠けている」とへイル氏は語る。
Paylocityは2023年後半にAPI開発ツール「Postman」を採用しており、同社の開発者の大多数はPostmanに慣れている。2025年4月、Postmanに「Spec Hub」機能が実装された。この機能がAPI仕様の更新に役立つとヘイル氏は期待する。
Postmanを提供するPostman社の創設者兼CEOであるアビナブ・アスタナ氏は、Spec Hubについて次のように語っている。「Spec Hubにより、OASのバージョン3.0、もしくはAPI仕様『AsyncAPI』のバージョン2.0を、APIコレクションとシームレスに同期できるようになった。API仕様からAPIコレクションを生成することも、その逆も可能だ」
「さらに、検証、リンティング(構文やスタイルの自動チェック)、ガバナンスルールを組み込んだ。これにより、API仕様が自社のガバナンスに準拠しているかどうかを確認できる」(アスタナ氏)
現在、Paylocityの開発チームは、開発プロセスにSpec Hubをどう組み入れるか、同社のガバナンス担当チームと話し合っているという。
へイル氏は、開発者が考え方を変革する必要性についても次のように言及する。「API仕様について、“触れたくない。ソースコードを書いてAPIを開発すればいい”という考え方から、“チームと協力でき、ソースコード管理ツール『GitHub』に同期でき、コーディングの際の指針となる素晴らしい設計インタフェースだ”という考え方に移行する必要がある。Postmanならそれが可能だと思う」
翻訳・編集協力:雨輝ITラボ(リーフレイン)
Copyright © ITmedia, Inc. All Rights Reserved.
TechTarget発 世界のインサイト&ベストプラクティス
米国TechTargetの豊富な記事の中から、さまざまな業種や職種に関する動向やビジネスノウハウなどを厳選してお届けします。
この記事の著者
関連記事
新着ホワイトペーパー PR
-
比較資料
[セコムトラストシステムズ株式会社] 「自社に合うEDR」はどれか分かる? 比較・検討時の見極めポイントを解説 -
製品資料
[アルプス システム インテグレーション株式会社] まだ社内で眠らせたまま? AI活用の糧となる「データ資産」を有効利用するには -
市場調査・トレンド
[AvePoint Japan株式会社] “SCS評価制度”対応の第一歩、自社環境と要求事項とのギャップを把握する方法 -
製品資料
[株式会社BREXA Technology] 情報整理の自動化でインシデントの初動対応を効率化、AIエージェント活用のコツ -
製品レビュー
[ヴィーム・ソフトウェア株式会社] SCS評価制度を導入するだけで十分? 組織の防御力を高める活用方法とは
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
情シスの約8割が転職や退職を意識 調査で分かった“辞めたくなる最大の理由”
-
2
「WSUS」終了の時限爆弾 “本命”移行先ツールとMicrosoft提唱の新管理手法
-
3
「IBM i(AS/400)はクローズドなシステム」という誤解 DXに寄与する一歩
-
4
「Wi-Fi 7」経由でWindowsが乗っ取られる? 最高権限奪取の恐怖
-
5
パッチなしで「今すぐサーバを落とせ」 Kiteworks異例警告の波紋
-
6
Claude Codeでは「エージェントを作るな、スキルを作れ」 Anthropicが示すAI構築術
-
7
「企業におけるAI導入検討度とIT投資優先度」に関するアンケート
-
8
「SCS評価制度 × 日本HP PC」に関するアンケート
-
9
「企業におけるAIの運用」に関するアンケート
-
10
「完璧な設計」なのに3000万円溶けた AWSの失敗事例から学ぶ3つの教訓
ホワイトペーパーランキング PR
-
1
「Google Workspace」活用事例34選、先進の生成AIによる組織変革の全貌
-
2
Linuxのスキルを証明する“激推し”の認定資格はこれだ
-
3
バックアップは“取っているから大丈夫”なのか? ランサムウェア時代の備え方
-
4
ネットワーク遅延の原因、「パケットロス」の基礎知識と効果的な解決策
-
5
月1000枚の紙を削減 9年動けなかった組織が、業務改革のその先に得たもの
-
6
「改正物流効率化法対策」徹底解説 総物流費を抑制するサプライチェーン戦略
-
7
Windows PCとMacの選択制で生産性向上 LINEヤフーが実践する運用管理方法とは
-
8
ソフトウェア開発の属人化と手戻りをどう防ぐ? 速さと品質を両立させる方法
-
9
AI活用を停滞させる「2:6:2の壁」を乗り越えるためのポイントとは?
-
10
ドラマで分かる、標的型攻撃メールの被害を受ける企業と回避できる企業の分岐点
TechTargetジャパン SNS
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー