この記事では、DevOps が API をどのように管理するかについて説明します。

導入

中国企業における DevOps コンセプトの普及と発展に伴い、中国企業における DevOps 実装の成熟度は継続的に向上しています。中国情報通信研究院のデータによると、企業の約 60% が完全なライフサイクル管理に移行しています。 R&Dのライフサイクル管理全体において、API管理の位置づけはますます重要になっています。 API の数が大幅に増加するにつれて、新しい API 管理要件も出現しました。 DevOps ワークフローで API のライフサイクル全体をどのように管理するかは、プロジェクト開発にとって非常に重要です。

1. DevOpsにおけるAPI管理のジレンマ

実際の DevOps ワークフローでは、API 管理は標準化、コラボレーション、自動化の品質、反復、自動化という 6 つの困難に直面します。

ジレンマ1：規制の実施の難しさ

チーム内の API ドキュメントの品質にばらつきがあるため、仕様を実装することが困難です。その理由は、同社には多くの研究開発プロジェクトとチームがあるからです。チームによって API 管理の習慣が異なり、特に一般的に使用されている Swagger 管理方法が異なるため、統一されたプラットフォーム管理を実行することが困難になります。このジレンマに対処するには、統合 API 管理プラットフォームを使用してドキュメント テンプレートを標準化し、作成プロセスと習慣をガイドするか、自動化されたドキュメント管理ツールを使用してプロセスを簡素化し、管理効率を向上させることができます。

ジレンマ2：仕事上の連携の難しさと情報伝達の効率の悪さ

DevOps ツール チェーンでは、ツールごとに通知メッセージが異なるため、重要な情報が複雑な通知に埋もれてしまいます。第二に、ワークフローには多くのリンクがあり、長く、さまざまな職務が異なるペースで作業を処理するため、タスク チェーンの上流と下流のコミュニケーションの効率が低下します。このジレンマに対処するには、プロセス手順を短縮し、より自動化されたプロセスを有効にします。同時に、優先度に基づいて差別化された通知スタイルを提供するために、洗練された通知ルールが策定されます。最後に、レビューメッセージを毎日プッシュすることで、その日の作業項目とメッセージ通知を整理し、漏れを防ぎます。

ジレンマ3: 自動テストシステム構築のハードルが高い

従来の自動インターフェース テスト スクリプトは Python で記述する必要があり、参入障壁が高く、コストも高くなります。完全に手書きであるため、開発の変更後には、インターフェースのすべてのスクリプトをドキュメントに従って再度調整する必要があります。また、自動テストは初期段階で多くの時間を要し、準備作業も複雑です。このジレンマに対処するには、インターフェースベースの自動テスト ツールを使用して、スクリプト作成のハードルを下げることができます。また、ワンストップ API フルライフサイクル管理プラットフォームを使用することで、多くの事前作業を回避し、自動テストの効率を向上させることもできます。

ジレンマ4: APIの生産品質とオンラインの異常を発見、追跡、解決するプロセスが長すぎる

現在、バックエンドインターフェースセルフテスト、フロントエンド MOCK テスト、スモークテスト、統合テスト、例外監視の 5 つのリンクで異なるツールが使用されています。その結果、ツール間のドッキングが複雑になり、データが分離され、API 生成の品質が低下し、作業の重複が多く発生します。統合された API 管理ツールを使用すると、さまざまな段階でワークフローを接続し、R&D の品質と効率を向上させることができます。

ジレンマ5: インターフェースドキュメントでは反復バージョンを追跡できないため、バックトラッキングが困難になる

Swagger などの従来のインターフェース管理ツールには、インターフェースの変更記録がなく、バージョン管理が欠如しており、ログを通じて問題を特定できず、ロールバックや履歴比較を実行することもできません。さらに、チームにはインターフェース反復計画がなかったため、開発量と影響分析を評価することが困難でした。 R&D プロジェクトの重要な資産として、インターフェース ドキュメントの履歴記録の提供を含め、インターフェース ドキュメントの変更点をレビューする必要があります。ワンストップ API ライフサイクル管理ツールは、プロジェクトレベルのインターフェース バージョン管理とインターフェース反復計画を提供し、より高品質のインターフェース ドキュメントを出力し、DevOps ワークフローの効率を促進します。

ジレンマ6: DevOpsワークフローではツールが多すぎる

DevOps はマクロレベルの R&D 管理アプローチですが、現時点では大規模かつ包括的なツールは存在しません。その結果、企業内にはデータの流れを妨げるツールがますます増えています。さらに、従来のインターフェース管理ツールの機能も非常に限られています。この問題に対処するには、統合された API ライフサイクル管理ツールを使用して、インターフェースに関連するすべての問題に対処し、ドッキング ツールの数を減らすことができます。

DevOps における API 管理には何が必要ですか?

前述の DevOps における API 管理の問題に基づいて、企業の R&D ニーズを次の 6 つの側面に整理できます。

• 標準化: 仕様を設定し、仕様に基づいてAPIドキュメントを自動生成できるAPI仕様ツール
• 高い連携性：インターフェース関連の状態を自動転送し、情報を正確に通知するAPI連携ツール
• 自動化: 敷居の低いインテリジェントなデータ入力 API 自動化テスト ツール
• 高品質: ワンストップインターフェース品質管理のためのAPIテストツール
• 高速反復: プロジェクトレベルの反復計画、バージョン管理、インターフェースレベルの履歴記録を提供する API 管理ツール
• ツールチェーン: インターフェースの完全なライフサイクルと複数の外部統合方法を備えた DevOps ツール

私たちは、これらの条件を満たすツールを、API フルライフサイクルインテリジェントコラボレーションプラットフォームと定義しています。この統合プラットフォームでは、開発からリリース、運用に至るまで、API のライフサイクル全体を管理できます。

プラットフォームアドレス: https://www.eolink.com/apikit?utm_source=mo04sssjsh。

3. APIライフサイクル管理をDevOpsに統合する方法

典型的な DevOps フローチャートに従って、計画、開発、構築、テスト、展開、リリース、運用と保守、監視の側面から API 管理ツールの接続を検討します。

1. 計画: APIドキュメント仕様を策定し、明確に構造化されたAPIウェアハウスを構築する

• 会社の組織構造とシステム サービスの配分に応じて、明確に階層化されたインターフェイス ウェアハウスが形成されます。
• 標準の策定を統一し、さまざまなチームの標準を会社の標準に統一します。
• 公開資料を整理し、履歴ドキュメントを API ウェアハウスにすばやくインポートし、頻繁に使用されるデータ構造、API ドキュメント テンプレート、共通フィールドの説明などの再利用可能な資料を API ウェアハウスに保存して、開発フェーズで新しい API ドキュメントを作成しやすくします。

2. 開発: コードリポジトリに基づいて自動化されたプロセスを構築し、フロントエンドとバックエンドのデバッグと通信の問題を解決します。

コード リポジトリ、Swagger、またはローカル R&D ツールに基づいて、API ドキュメントを自動的に生成し、迅速にデバッグできます。デバッグ後、MOCK API とバッチ インターフェースのユース ケースを自動的に生成し、フロントエンドとテスターとオンラインで共有できます。ドキュメントはオンラインコメントをサポートしています。最後に、この API ドキュメントに基づいてビジネス コードを生成し、開発を支援できます。

3. ビルド: インターフェースバージョンを自動的にビルドし、スモークテストを自動的に実行し、ロールバックをサポートし、テストエンジニアの負担を軽減します。

構築フェーズでは、CI トリガーに基づいてインターフェース バージョンを自動的に構築し、後続のバージョンのロールバックを容易にすることができます。インターフェースバージョンやバージョンの違いの比較に基づいてバッチテストを実行することもできます。

これら 2 つのステップにより、テスターはタスクを評価し、テストのプレッシャーを軽減することができます。現在、インターフェース上で自動的に検出できる問題は、API テストを通じて事前に検出できます。

4. テスト: 自動テストを促進し、ユースケースの作成コストを削減する

テストフェーズでは、自動テストをお勧めします。統合された API ライフサイクル管理ツールは、以前の開発フェーズで生成されたテスト ケースをすばやく同期し、これらのテスト ケースのプロセスを調整して自動テスト ケースを形成します。また、API ゲートウェイの監視ログに基づいてトラフィックを再生したり、自動テスト ケースを自動的に生成したり、増分インターフェイスを識別したり、ファジー テストを実行したりすることもできます。シナリオケースを作成し、回帰テストを実行できます。ファズ テストはテスト結果を追跡し、対応するテスターに​​テスト レポートを送信します。

5. 展開: コアプロセスを迅速にテストし、環境の違いを排除する

展開後、CD トリガーを使用して環境を予測し、コア テスト シナリオをテスト実行し、対応するテスト レポートを生成できます。複数の環境のテスト結果を比較して、環境の違いによって発生する問題をトラブルシューティングしたり、展開後にストレス テストを実行したりできます。 （注：Eolink Apikit ストレステスト機能は年内にリリースされる予定ですので、お楽しみに）

6. リリース: スムーズで安全な外部アクセスを確保する

リリースフェーズでは、システムは主に API ゲートウェイに接続され、通常の外部アクセスとオープン インターフェイス機能が許可されます。

7. 運用と保守：サービスの継続的な安定性とセキュリティの確保

運用および保守フェーズでは、API ゲートウェイはトラフィック制御、負荷分散、またはサービス ガバナンスに引き続き使用されます。オープンインターフェースでは、Open API 呼び出し管理、オンライントライアル、認証を行うことができます。インターフェース トランザクションでは、インターフェースのホスティング、転送、請求計算、注文管理を行うことができます。

8. 監視: インターフェースの動作をリアルタイムで監視し、異常なアラームを適時に発行します。

標準インターフェース監視インジケーターを設定し、より柔軟な監視構成を作成し、アラームのルールを事前に設定できます。これらのアラームの事前設定された条件が満たされると、携帯電話のテキスト メッセージ、主流の IM ツール、Webhook などのメッセージ通知が送信されます。

メッセージ通知に関しては、DevOps メインプロセスとの接続だけでなく、DevOps 情報フロー全体の効果的かつタイムリーな配信を確保することが重要であると考えています。したがって、API ドキュメントの変更、テスト レポート、監視アラームをインテリジェントに配布する必要があります。たとえば、段階的なプッシュ、インテリジェントな誘導、ハイリスクのマーキングなどです。

[重要] DevOps ワークフロー ドッキング API の完全なライフサイクル管理プロセス図

4. 異なる規模のチームに実装する方法

1. 大規模チーム: DevOpsサイクル全体にわたるインターフェース自動化

大規模なチームの場合、DevOps のフルサイクルに基づくインターフェース自動化ソリューションが推奨されます。これには、Eolink Apikit プライベート クラウド バージョンの導入が必要です。このソリューションでは、Swagger の URL を Eolink Apikit に自動的に同期し、ドキュメントを自動的に生成し、そのドキュメントに基づいてビジネス コードをさらに生成してコード リポジトリに送信し、CI パイプラインをトリガーしてドキュメントのバージョン管理を行い、ファズ テストを実行して、レポートを担当者に送信します。 CD フェーズでサービスが展開された後、環境を事前テストし、要件に基づいてストレス テストを実行し、テスト レポートを対応する関連担当者に送信できます。 CICD に加えて、Eolink のゲートウェイ製品を統合して、API の運用・保守管理を行うこともできます。

2. 小規模チーム: コスト効率の高いインターフェース自動化

小規模チームの場合、よりコスト効率の高い SaaS エンタープライズ バージョンでは、プラグインを使用して API ドキュメントを生成し、Eolink Apikit にアップロードし、テストを実行してテスト ケースを自動的に生成できます。

現在、この費用対効果の高いソリューションは、設計、開発から構築、リリース、展開までのプロセス全体をカバーしています。運用・保守、監視、ストレステストなどの面ではまだ不十分ですが、コア API の完全自動化された管理プロセスには十分です。

要約する

この記事では、統合 API 管理プラットフォームを使用して DevOps ワークフローにおける API のライフサイクル全体を管理し、これまで複数のツール間で発生していたデータの分離やプロセスのブロックの問題を解決することを提案します。

API フルライフサイクル管理プラットフォームである Eolink Apikit は、API 設計、ドキュメント管理、自動テスト、監視、R&D 管理、チームコラボレーションを組み合わせたワンストップ API R&D コラボレーション プラットフォームです。これは、API R&D 管理のベスト プラクティス製品であり、個人の開発者から多国籍企業のユーザーまで、API のライフサイクル全体を迅速かつ標準化して管理し、R&D の効率を向上させるのに役立ちます。

プラットフォームアドレス: https://www.eolink.com/apikit?utm_source=mo04sssjsh。