API 開発者エクスペリエンスが重要な理由
これは、API Connectivity Manager に関する 2 部構成のシリーズの 2 番目の投稿です。
- API の拡散を防ぐ 5 つの方法 (そしてなぜ気にする必要があるのか)
- API 開発者エクスペリエンスが重要な理由 – この投稿
API は現代のビジネスの中心です。 API は常にソフトウェア開発において重要な役割を果たしてきましたが、データ統合の需要の高まりにより、あらゆる事業分野で API が広く採用されるようになっています。 しかし、API はデータとapplicationsを接続するだけではありません。外部のビジネス パートナーとのコラボレーション、顧客へのサービスの提供、そしてそれ自体が製品として収益を生み出すためにも重要です。
開発者は API エコノミーの中心で重要な役割を果たします。 API の構築、統合、保守を担当し、API の作成者と技術的な採用者の両方です。 彼らの経験は、一般的にAPI 開発者エクスペリエンスと呼ばれ、API の全体的な成功を決定する最も重要な要素の 1 つです。この記事では、API 開発者エクスペリエンスの主要な概念と、IT リーダーが API エクスペリエンスを計画する際に考慮する必要がある事項について説明します。
API 開発者エクスペリエンスとは何ですか?
API 開発者エクスペリエンスとは、開発者が API を操作する際に抱く全体的な認識と感情を指します。これには、API をapplicationsに統合する開発者にとって楽しくスムーズなエクスペリエンスに貢献するインフラストラクチャ、ツール、プロセス、サポート、その他のタッチポイントが含まれます。 API 開発者エクスペリエンスは、全体的な開発者エクスペリエンスのサブプラクティスです。
API 開発者エクスペリエンスが重要な理由
ユーザー エクスペリエンスへの徹底的な重点が第一世代の技術革新を推進したのであれば、次世代の成功企業は開発者エクスペリエンスに重点を置くことで勝利するでしょう。
API エコノミーが拡大し続けるにつれて、どの API が採用されるかについて開発者がより大きな影響力を持つようになります。 API を見つけるのが難しかったり、適切なドキュメントがなかったり、メンテナンスが不十分だったりすると、開発者はそれを放棄して、よりシンプルで高速な代替手段を選択します。 これは、内部 API プログラムだけでなく、パートナーや顧客向けの外部 API にも同様に適用されます。
外部 API の場合、開発者が API を放棄すると、ビジネスに具体的な影響が生じます。直接の顧客からの収益が失われるだけでなく、顧客が使用する製品やソリューションのより広範なエコシステムへのアクセスも失われます。 社内 API プログラムであっても、開発者エクスペリエンスの低さから、市場投入までの時間の遅延、開発者の生産性の低下、やり直しの増加などの影響を受け、ビジネスの成功を危うくする可能性があります。
開発者中心の世界で成功するには、API ライフサイクルのあらゆる段階で作業する開発者に適切なツールとリソースを提供する API 戦略が必要です。 これを実現する最善の方法は、次の 3 種類の API 使用法を網羅する、開発者向けの思慮深いエンドツーエンドのAPI エクスペリエンスを作成することです。
- APIの導入と管理
- APIの発見とテスト
- APIの監視とセキュリティ保護
優れた API 開発者エクスペリエンスを構築するにはどうすればよいでしょうか?
ポジティブなエクスペリエンスを生み出すには、開発者がどのように API を使用するか、タスクを完了するために何が必要か、そして最終的に API を使用しているときにどのように感じるかを理解することが重要です。API と対話するペルソナを定義したら、全体的な API エクスペリエンスの計画を開始できます。
API 開発者エクスペリエンスを設計する際に考慮すべき 4 つの原則があります。
- ユーザーの識別– API とやり取りしているのは誰ですか?
- 機能の定義– API は何を行うのか?
- 使いやすさを最適化– API はどれくらい使いやすいですか?
- エクスペリエンスの向上- API の使用感はいかがですか?
それぞれの原則と、開発者にとって最適な API エクスペリエンスを実現するために何を提供する必要があるかを見てみましょう。
ステップ1: ユーザーの識別
特定の顧客の問題に対応する製品を設計するのと同様に、開発者の懸念に対処するために、インフラストラクチャと製品全体の API エクスペリエンスを設計する必要があります。 開発者は単なる最終消費者ではなく、全体的なインフラストラクチャの構築者および保守者でもあります。
API 開発者エクスペリエンスを設計する際に考慮すべき主なペルソナは 3 つあります。
- API コンシューマー–applicationsの API 統合を検出、実装、維持する
- API 所有者– サービス用の API を計画、構築、文書化、テスト、展開、管理します。
- インフラストラクチャ管理者– グローバルポリシーを設定し、セキュリティとコンプライアンスのために API を監視する
考慮すべき追加のユーザーや関係者がいる可能性があります。 たとえば、API コンシューマーのカテゴリには、それぞれ異なるペルソナと要件を持つ社内開発者、パートナー、顧客などのサブカテゴリが含まれる場合があります。
ステップ2: 機能を定義する
機能は成功する API の基盤です。 優れた API を使用すると、開発者は貴重なデータやサービスと統合し、タスクをより速く完了し、新しい機能の開発に費やす全体的な時間を短縮できます。 主な考慮事項は次のとおりです。
- API はデータやサービスと統合することでどのような価値をもたらしますか?
- API は呼び出しを減らし、データを構造化することで問題をどの程度解決しますか?
- 可用性、信頼性、スケーラビリティの面で、 API はどの程度信頼できますか?
API の機能は、開発に対する API ファーストのアプローチと密接に絡み合っています。 「コード ファースト」とは対照的に、「API ファースト」では、コード開発が始まる前に API 仕様が記述され、API リクエストの構造と返されるデータに重点が置かれます。 この重点により、API が開発者が必要とする価値と機能を一貫して提供できるようになります。
ステップ3: ユーザビリティの最適化
3 番目の原則である「使いやすさ」は、開発者が API を使って何ができるかではなく、どのように API を使用するかに焦点を当てています。 検出、学習、テスト、オンボーディングをサポートする API 関連のリソースをカバーします。 インフラストラクチャ、ツール、ドキュメントのサポートエコシステムがなければ、開発者は API を使用するのに苦労することになります。 重要な考慮事項は次のとおりです。
- 統合されたシングルサインオン（SSO）によるシンプルなサインアップとAPIキーの簡単な管理
- 最新の参考資料とコード例を含む明確で徹底したドキュメント
- 基本的なAPIリクエストの作成にかかる時間は5分未満と短く、セットアップ時間が短い
Postman の2022 年 API の現状レポートでは、調査回答者は API の使用における主な障害として次の点を挙げています。
- 文書の不足（55%）
- API の発見に苦労する (38%)
- 基本的なAPI知識の欠如（30％）
徹底したドキュメント、コード例、API を試すためのツールを備えた中央開発者ポータルを活用することで、これらの問題を克服できます。
ステップ4: エクスペリエンスの向上
API 開発者のエクスペリエンスは、API コンシューマーと API 所有者間のやり取りの合計です。 基盤は API の機能性と使いやすさに基づいて構築されていますが、API を操作する全体的な楽しさに貢献する追加のインタラクションがあります。これには次のものが含まれます。
- Stack Overflow、Slack、Discord、Twitter などのチャネルでアクティブなコミュニティを利用できます。
- 開発チームからのタイムリーな対応によるアクセスしやすいサポート
- API、ドキュメント、コミュニティとやり取りする際のスムーズな体験
API での作業を楽しむ開発者は、その API を同僚に推奨したり、API を中心に新しい機能を構築したり、自分のアプリに統合したりする可能性が高くなります。
API開発者のエクスペリエンスが重要
優れた API 開発者エクスペリエンスの鍵となるのは、API だけでなく、それを取り巻くツール、プロセス、ドキュメント、サポートのエコシステムです。 API エコシステムのすべての部分がシームレスに動作することで、摩擦と複雑さが軽減され、開発者はapplicationsの構築に集中できるようになります。
上記の手順は、API 開発者エクスペリエンスを設計、実装、テスト、評価する継続的なプロセスの一部です。 ユーザーの特定、機能の定義、ユーザビリティの最適化、エクスペリエンスの向上といった各主要ステップに重点を置くと、使用するのが楽しく、さらには楽しい API を構築できます。
NGINX は API 開発者のエクスペリエンスをどのように向上させるのでしょうか?
F5 NGINX Management Suiteの一部であるAPI Connectivity Manager は、API 開発者エクスペリエンスを中核として設計されました。 API Connectivity Manager を使用すると、インフラストラクチャ チームは高性能な API ゲートウェイと開発者ポータルを導入できます。 また、開発者は API とドキュメントを迅速に公開および管理したり、API を検出してapplicationsにオンボードしたりすることができます。
API 接続マネージャーの利点は次のとおりです。
- 迅速なオンボーディング– お気に入りの ID プロバイダーと統合して、開発者ポータルでの承認と認証を効率化します。
- シンプルなドキュメント– API 所有者が API を API ゲートウェイに公開すると、 OpenAPI 仕様を使用して開発者ポータルのドキュメントが自動的に生成されます。
- インタラクティブな学習– 開発者ポータルに統合された API エクスプローラーを使用して、開発者が API を発見、テスト、学習できるようにします。
- ワークフロー自動化- 完全に宣言的な REST API を使用して、API の公開と管理を CI/CD パイプラインに統合します。
始める
API Connectivity ManagerとInstance Managerを含むNGINX Management Suite の30 日間無料トライアルを開始します。
関連リソース
「このブログ投稿には、入手できなくなった製品やサポートされなくなった製品が参照されている場合があります。 利用可能な F5 NGINX 製品およびソリューションに関する最新情報については、 NGINX 製品ファミリーをご覧ください。 NGINX は現在 F5 の一部です。 以前の NGINX.com リンクはすべて、F5.com の同様の NGINX コンテンツにリダイレクトされます。"