完璧なAPIを設計することが簡単なことではないことは承知しています。各APIは意図を持って作成され、品質と機能性を確保するための対策が織り込まれています。OpenAPI（以前はSwaggerとして知られていました）のようなAPI定義形式は、このプロセスに標準化を提供し、開発チームが各APIの振る舞いを記述し、決定するための契約となります。しかし、APIの品質を確保することは、APIを設計した後で終わりではありません。
APIの品質は部門の壁を超え、設計された価値をAPIが継続的に提供していることを確認する必要があります。APIを監視することで、それがプリプロダクション環境でのAPI監視であろうと、プロダクション環境での監視であろうと、APIのパフォーマンスと振る舞いを完全に可視化することができます。
APIを監視することで何が得られますか？
監視ツールは、APIがどのように機能しているかについての洞察を提供します。設計がどのように実現され、時間の経過とともにどのように機能し、パフォーマンスを発揮しているかを理解することは、以下に役立ちます。
- 問題の特定
- 問題の修正
- 機能分析
- 新リリースに向けた反復
最終的に、APIを監視することは改善に役立ちます。エンドユーザーの前に問題を捕捉し、APIのパフォーマンス、可用性、正確性に関するフィードバックと実行可能なデータを受け取ることで、継続的に革新し、より高い採用率を推進できます。
では、合成監視ツールとは一体何ですか？
合成監視は、デジタル資産を監視するためのプロアクティブなアプローチです。合成監視ツールは、アプリケーションやAPIが実行する主要なアクションやトランザクションを実行することで、実際のユーザーをエミュレートします。実際のユーザーインタラクションを監視するのではなく、合成監視は組織がユーザーが*遭遇するであろう*ものを監視する方法を提供するため、実際のユーザーが問題に遭遇する前に、あらゆる問題やパフォーマンスの逸脱を捕捉し、修正することができます。
API監視は通常、APIエンドポイント監視とAPIトランザクション監視の2種類に分けられます。APIエンドポイント監視は各エンドポイントが適切に機能していることを保証し、APIトランザクション監視はマルチステップ監視をサポートし、シーケンスの各ステップからデータを取得します。
これはAPI開発チームにとって何を意味しますか？
企業は、設計がソフトウェア開発ライフサイクルの不可欠な部分であるという価値をますます認識しています。しかし、これらの設計をビジネス構造の他の要素でうまく活用できる企業はごく少数です。
開発者として、OpenAPI仕様ファイルのような作成する成果物が会社で適切に使用されていることを確認することは非常に重要です。APIライフサイクルの次のステップを理解することで、設計プロセスだけでなく、それに続くプロセスも改善できます。真のDevOps文化を実現するには、コラボレーションと相互運用性が不可欠であり、開発チームはDevOpsイニシアチブをサポートする上で重要な要素です。
OpenAPI仕様ファイルを再利用してAPIを監視する
APIモニターを設定する際、使用するツールによっては、チェックしたいエンドポイントやトランザクションを指定する必要があり、場合によっては、APIを本質的に再テストするための精巧なスクリプトを作成するのに追加のリソースが必要となることがあります。これは、CICDイニシアチブやアジャイルプロセスをサポートするチームにとって、選択肢ではないことを理解しています。
そのため、SmartBearの合成監視ツールであるAlertSiteの友人たちが、OpenAPI仕様ファイルを再利用して新しいAPIモニターを作成するサポートを導入したことを発表できることを嬉しく思います。これにより、Swagger Toolsで設計したAPIのパフォーマンス、可用性、機能の正確性を簡単に監視できるようになります。AlertSiteは、追加のコーディング要件なしで、わずか数分で稼働を開始できます。
この新しい統合により、開発チームは既存のOAS定義（現在OAS（またはSwagger）2.0をサポート）を運用チームに渡すだけで、APIが期待通りに機能していることを確認するためのモニターを自動生成できます。あるいは、さらに良いことに、開発チームはOAS定義を活用してプリプロダクション環境で新しいモニターを作成できます。
なぜこれが重要なのでしょうか？
DevOps環境で作業する組織が既存のアセットを再利用できる場合、展開プロセスにおける摩擦を減らし、不必要な障害を排除できます。OASへの「設計優先」アプローチに従うには、各APIの機能に対する期待と要件の詳細な計画が必要であり、それを展開までの時間と平均解決時間を短縮する方法で実行できることは、アジャイルチームにとって不可欠です。
もう1つの大きな利点は、API定義を活用して新しいモニターを作成することから生まれる、部門横断的なコラボレーションと連携です。APIが進化し、新しいバージョンがリリースされるにつれて、開発チームと運用チームはOAS定義を再利用してモニターを更新し続け、APIが期待通りに機能し続けることを保証できます。
AlertSiteのOpenAPI仕様サポートは、API監視の武器庫に追加され、開発者と運用チームの両方が、依存するAPIのステータスと振る舞いを簡単に判断できるようにします。AlertSiteは、DevOpsチームが異常を継続的に監視し、実行可能で状況に応じたデータを含むターゲットアラートを送信できるようにすることで、あらゆる問題を迅速に解決し、APIが利用可能であるだけでなく、その設計で envisioned されたエクスペリエンスを提供することを保証します。AlertSite API監視機能のこの強化は、2018年に計画されているエキサイティングな新しい統合と機能の最初のものです。
お読みいただきありがとうございます！さらに多くのAPIリソースをお探しですか？Swaggerニュースレターを購読してください。毎月、最高のAPI記事、トレーニング、チュートリアルなどを含むメールが届きます。 購読する