第4章 3scale toolbox による API ライフサイクルの自動化

1.ストラテジー

目的、リソース、ターゲットマーケット、タイムフレームを含む API の企業ストラテジーを決定し、計画を立てる。

目的を達成するための明確な計画と共に、企業ストラテジーが定義される。

2.設計

API 契約を早期に作成し、プロジェクト間の依存関係を解消し、フィードバックを収集して、リスクを下げ、市場に出すまでの時間を短縮する (たとえば、Apicurio Studio を使用)。

利用者向けの API 契約により、API で交換できるメッセージが定義される。API 利用者がフィードバックを提供している。

3.モック

実際の例と負荷を想定してさらに API 契約を規定し、API 利用者がこれを使用して実装を開始できるようにする。

モック API が稼働中で、実際の例を返す。例を想定した API 契約が完成する。

4.テスト

ビジネスを想定してさらに API 契約を規定し、開発した API のテストに使用できるようにする。

受け入れテストのセットが作成される。ビジネスを想定した API ドキュメントが完成する。

5.実装

Red Hat Fuse や希望の開発言語などのインテグレーションフレームワークを使用して、API を実装する。実装と API 契約を一致させる。

API が実装される。カスタム API 管理機能が必要な場合は、3scale APIcast ポリシーも開発される。

6.デプロイ

CI/CD パイプラインを 3scale toolbox で使用して、API インテグレーション、テスト、デプロイメント、および管理を自動化する。

CI/CD パイプラインにより、API が自動化された方法で実稼働環境に統合、テスト、デプロイ、および管理される。

7.保護

API が保護されるようにする (たとえば、セキュアな開発プラクティスと自動化されたセキュリティーテストを使用)。

セキュリティーガイドライン、プロセス、およびゲートが準備される。

8.管理

環境間の API プロモーション、バージョン管理、非推奨化、および廃止をまとめて管理する。

API をまとめて管理するためのプロセスとツールが準備される (たとえば、セマンティックバージョン管理により API の変更の違反を防止)。

9.検出

API をサードパーティーの開発者、パートナー、および内部ユーザーにプロモーションする。

デベロッパーポータルが稼働中で、最新版のドキュメントがこのデベロッパーポータルに継続的にプッシュされる (たとえば、3scale ActiveDocs を使用)。

10.開発

サードパーティーの開発者、パートナー、および内部ユーザーが API をベースにアプリケーションを開発できるよう支援する。

デベロッパーポータルに、ベストプラクティス、ガイド、および推奨事項が含まれる。API 開発者がモックエンドポイントおよびテストエンドポイントにアクセスし、ソフトウェアを開発する。

11.利用

API 利用の増加を処理し、多数の API 利用者を管理する。

ステージングされたアプリケーションプランが利用でき、最新の価格と制限が継続的にプッシュされる。API 利用者が CI/CD パイプラインから API キーまたはクライアント ID/シークレットの生成を統合できる。

12.監視

API の健全性、品質、および開発者の関与について、実際の定量化されたフィードバックを収集する (たとえば、最初の Hello World! の時間のメトリクスなど)。

監視システムが準備される。ダッシュボードに API の KPI (たとえば、稼働時間、分ごとのリクエスト数、レイテンシーなど) が表示される。

13.収益化

新しい収益を大規模に獲得する (このステージはオプション)。

たとえば、小規模な API 利用者を多数獲得することをターゲットにする場合、収益化が有効化され、利用者が使用量に基づいて自動的に課金される。