API の標準化をスケールアップ、最適化、加速させる 5 つのステップ フレームワーク

組織が需要の増加、期待される品質、規制上の要件を満たそうとする中で、一貫性は API 開発を加速する上で最も重要な要素の 1 つです。

開発者に対する一貫した API 設計がなければ、最終結果が意図した目的に一致する、または API に応じたアプリケーションが適切に機能できるという保証はありません。 大規模な場合、一貫した設計標準の欠如は、開発者の生産性に悪影響を及ぼし、API 品質を低下させ、API のデリバリー サイクルを増加させる可能性があります。

「2020 State of API Report」によると、標準化は 58% 以上の組織にとって依然として最重要課題となっています。 特に、デジタルイニシアチブをサポートするために API の制作を増やしている大企業にとっては重要です。 これは、設計品質が優れた顧客体験の一貫した提供に直接影響を与える場所であり、そのため、企業にとって最優先事項になっています。 この「5つのステップフレームワーク」は、標準化の取り組みに対する潜在的な障害を克服するのに役立ちます。

API の標準化が重要な理由

設計図のない建設作業員のチームで超高層ビルを建設する無秩序を想像してみてください。 設計の標準化が欠如していると、構造上の障害、コスト超過、期限の失敗につながる可能性があります。 同じシナリオが API 標準にも当てはまり、開発コストの増加、ユーザーの不満、業界および規制基準の不履行など、組織や主要な利害関係者に大きな問題を引き起こす可能性があります。

簡単に言えば、社内のチームと外部のコンシューマーは、API 設計を理解するために貴重な時間を費やすべきではありません。 ユーザーが API を複雑だと感じたり、ドキュメントが分かりにくいと感じたりした場合、他の場所で代替手段を探すことを覚えておくことが重要です。

設計標準化の利点

明確な設計手法により、API がビジネス ニーズに合致していることを確認できます。設計に 5つのステップ フレームワークを使用すると、曖昧さが減り、コラボレーションが活発になり、品質が確保され、API の採用率が高まります。

設計標準の実装に成功した組織には、次の利点があります。

• 設計がビジネスニーズに一致することを保証することによる、API の品質が向上します 。
• API 標準とガバナンスを自動化することにより、ピアレビューに費やす時間が短縮されます。
• 将来のバージョン管理の必要性を最小限に抑えて、開発者のコラボレーションを改善します。
• API 設計がすべての規制および業界標準に準拠していることを確認することにより、リスクを軽減します。

API 業界の規制要件

「デジタル」経済の拡大に伴い、API の急激な成長と導入が進んでいます。金融サービスやヘルスケアなどの一部の垂直産業では、API を管理する「業界必須基準」の導入につながっています。例えば、欧州委員会は、銀行・金融セクター向けに、Payment Services Directive 2 (PSD2)と呼ばれる一連の API 要件を導入しました。

PSD2 は、銀行が API を使用する際に必要な一連のルールです。 業界や組織は、ISO20022、FHIR、IATA、BIAN、SWIFT、Criterion などの必須規格も導入しています。 組織は、API が業界および規制の要件を確実に満たすように、厳格な API ガバナンスを実装する必要があります。

開発者にとってより良い体験です

明確で一貫性のある API 設計基準を持つことは、開発者と消費者の良好な体験の基盤となります。API の標準化により、開発者と消費者は迅速かつ効果的な方法で API を理解し、学習曲線を短縮し、一連のガイドラインに沿って構築することができます。

API の標準化は、チームコラボレーションを向上させ、不正確さや遅延を減らし、全体的な開発コストの削減に貢献するための指針を提供することもできます。 標準化は API 戦略の成功にとって非常に重要であるため、Microsoft、Google、IBM などの多くのテクノロジー企業やSWIFT、TMForum、IATA などの業界団体は、RESTful を定義するための基本的な標準として OpenAPI 仕様 (OAS) を使用およびサポートしています。

API 開発をスケーリングする際に関連する一般的な課題

2025 年までに、デジタル経済は世界全体で 23 兆ドル、世界の GDP の24.3% を占めると予想されています。この拡大に対応するために、企業は API 戦略を策定し、実施する必要があります。

そのためには、適切に設計された、一貫性のある、信頼性の高い API を基盤として構築する必要があります。大規模な組織内では、開発規模を拡大しようとすると、このような課題に遭遇することがよくあります。

• 同じ API の複数のバージョンが複数の場所に配置されている。
• コラボレーションや共有を必要とする同じ API に関わる複数の人々。
• 変更が発生した際の API ワークフローの制御と可視性の欠如。
• 正式なスタイル ガイドラインや設計のベストプラクティスの欠如。

これらの課題のほとんどは、組織が社内外のすべての開発チームに API 設計標準を導入し、実施することで解決できます。

なぜ標準化が API 開発のスケーリングに不可欠なのか？

API の設計と提供のプロセスにおいて、標準化なしに品質を確保することはできません。設計標準を強化することは、成功する結果を予測する能力を向上させ、品質を確保しながら API 開発を迅速に拡張する能力に貢献します。

標準化されていないと、個々の開発者は設計時に主観的な選択をすることができます。創造性は奨励されるべきものですが、スタイルガイドによって適切に管理されなければ、すぐに混沌としてしまいます。

標準化を強化するための正式なプロセスがなければ、API の設計と開発プロセスを成功裏に拡張したり、規制や業界標準に準拠したりすることはできません。API デザインのスタイル ガイドを持つことは、API 定義の構築やアセットの再利用の際に、社内外のチームが協力するために必要な「ガードレール」が提供されます。

標準化フレームワークの導入

標準化のメリットを理解していても、多くの組織はAPI設計に対するガバナンスの確立に苦労しています。 組織が設計標準を正常に実施し、組織全体でプログラムを拡張できるようにするために、「5ステップの実装フレームワーク」を開発しました。 これはSwaggerHubと組み合わせて機能し、開発者がOpenAPI定義の信頼できる唯一の情報源を探すことができる中央コラボレーションプラットフォームを提供します。

手順は次のとおりです。

1. ビジネスケースの定義
   1. 何を標準化するのか、なぜ標準化するのか？
   2. そのルールは誰に適用されるのか？
2. 標準化の重要な要素
   1. OAS 構文
   2. 標準化ルール (内部および外部の要件)
   3. カスタムルール
   4. ドメイン
3. 標準化ドライバーの導入
   1. 標準テンプレートの作成
   2. カスタムルールの作成
4. 教育とトレーニングの導入
   1. ライブトレーニングとドキュメント
   2. Q&Aチェック
5. プロセスの見直しと最適化
   1. ユーザーフィードバック
   2. 結果のレビュー
   3. 最適化

このブログシリーズでは、「5つのステップフレームワーク」と SwaggerHub を使って、企業全体に API 標準を導入する方法をご紹介します。これにより、開発コストの削減や API の品質向上など、ビジネスに多くのメリットがもたらされます。さらに言えば、正しく行われていれば、維持、採用、利用が容易になります。

次回のブログでは、実装フレームワークの最初の2つのステップである「ビジネスケースの定義」と「標準化の重要な要素」について詳しくご紹介します。

SwaggerHub  製品紹介ページは、こちら。
OpenAPI 仕様に準拠した API 設計とドキュメント化のためのプラットフォーム
https://www.xlsoft.com/jp/products/smartbear/swaggerhub.html

この資料は、SmartBear の Blog で公開されている「A Five Step Framework to Scale, Optimize & Accelerate API Standardization」の日本語参考訳です。