API 開發人員體驗為何至關重要

本篇是API Connectivity Manager 的系列文章（共兩篇）的第二篇

API 在現代業務中處於核心地位，在軟體開發中一直扮演著重要的角色。隨著資料整合需求的不斷增長，API 被更廣泛地應用於每條業務線。但API 的功能不僅限於連接資料和應用——它們對於與外部業務合作夥伴的合作、客戶服務的提供以及收入的創造（API 本身作為產品）都至關重要。

開發人員在API 經濟中發揮關鍵作用。他們負責建立、整合和維護API，他們既是API 的創建者，也是API 的技術採用者。他們的體驗——通常被稱為「API 開發人員體驗」 ——是決定API 全面成功的最重要因素之一。本文探討了API 開發人員體驗的幾個關鍵概念以及IT 領導者在規劃API 體驗時需要考慮的因素。

  1. API 開發人員體驗是什麼？
  2. API 開發人員體驗為何至關重要？
  3. 如何打造優秀的API 開發人員體驗？

API 開發人員體驗是什麼？

「API 開發人員體驗」是指開發人員在與API 互動時所產生的整體感知和情緒。它涉及基礎架構、工具、流程、支援以及其他接觸點，在將API 整合到應用中時，這些元素共同為開發人員提供一種愉悅、流暢的體驗。API 開發人員體驗是整體開發人員體驗的一個子實踐。

API 開發人員體驗為何至關重要？

如果說對使用者體驗的密切關注推動了第一代的技術創新，那麼下一代成功公司將憑藉對開發人員體驗的關注而脫穎而出。

隨著API 經濟的不斷擴大，開發人員對於應採用哪一種API 擁有越來越大的決策影響力。當API 難以發現，缺乏足夠的文檔，或維護不善時，開發人員就會放棄它，轉而選擇更簡單、更快速的替代方案。這同時適用於內部API 程式以及面向合作夥伴和客戶的外部API。

就外部API 而言，當開發人員摒棄您的API 時，會對您的業務產生實質的影響。您不僅會失去這部分直接客戶的收入，還會失去進入客戶更廣泛的產品和解決方案生態系統的機會。即使是內部API ，程式開發人員體驗不佳也會帶來不良後果，包括上市速度放緩、開發人員工作效率下降和返工增加，這些都有可能危及您的業務成功。

要想在以開發人員為中心的世界中獲勝，您需要製定API 策略，為在API 生命週期的各個階段工作的開發人員提供正確的工具和資源。要做到這一點的最佳方法是為開發人員提供全面的端到端API 體驗，其中涉及三種API 使用情況：

  • 部署和管理API
  • 發現並測試API
  • 監控和保護API

如何打造優秀的API 開發人員體驗？

要創造積極的體驗，您需要先了解開發人員如何使用您的API，他們需要什麼來完成任務，以及他們使用您的API 時的感受。在確定將與您的API 互動的角色之後，您就可以開始規劃整體API 體驗了。

當設計API 開發人員體驗時，需要考慮四個原則：

  1. 確定使用者－誰將與API 交互？
  2. 定義功能－API 要做什麼？
  3. 優化可用性－API 的易用性如何？
  4. 增強體驗－API 使用體驗如何？

以下就讓我們具體看下每個原則以及您需要怎麼做才能為開發人員建立出色的API 體驗。

Why Api Developer Experience Matters 4 Principles 2

第1 步：確定用戶

就像根據特定的客戶問題設計產品一樣，您需要圍繞基礎架構和產品來設計API 體驗，解決開發人員的實際問題。開發人員不只是最終消費者，也是整個基礎架構的建構者和維護者。

在設計API 開發人員體驗時，需要將三個主要角色納入考慮：

  • API 消費者－發現、實施和維護其應用程式的API 集成
  • API 擁有者－為其服務規劃、建置、記錄、測試、部署和管理API
  • 基礎架構管理者－設定全域策略並監控API，以確保安全性和合規性

您可能還需要考慮其他使用者和利害關係人。舉例來說，API 消費者類別可能包括內部開發人員、合作夥伴和客戶等子類別，每個類別都有不同的角色和要求。

第2 步：定義功能

功能是API 成功的基礎。良好的API 支援開發人員整合有價值的資料或服務，加速完成任務，並縮短開發新功能所需的總時間。主要考慮因素包括：

  • 透過整合資料或服務，API 能夠帶來什麼價值？
  • API 透過減少呼叫和資料結構化來解決問題的效果如何？
  • 在可用性、可靠性和可擴展性方面，API 表現如何？

API 的功能與API 優先的開發方法密切相關。與「程式碼優先」相比，「API 優先」是在程式碼開發開始之前編寫API 規範，強調API 請求的結構和傳回的資料。這可確保API 能夠持續提供開發人員所需的價值和功能。

第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。

NGINX 如何改善API 開發人員體驗？

API Connectivity Manager是F5 NGINX Management Suite的一部分，在設計時充分考慮了API 開發人員體驗。透過API Connectivity Manager，基礎架構團隊可以部署高效能的API 閘道和開發人員入口網站。開發人員可以快速發布和管理API 和文檔，或快速發現API 並將其整合到應用中。

API Connectivity Manager 的優點包括：

  • 快速入門－與您偏好的身分提供者整合，以簡化在開發人員入口網站上的授權和身分驗證
  • 簡單的文件－當API 擁有者向API 閘道發佈API 時，使用OpenAPI 規格會自動為開發人員入口網站產生文檔
  • 互動式學習－支援開發人員透過開發人員入口網站上的整合式API 資源管理器發現、測試和學習您的API
  • 工作流程自動化－使用完全聲明式REST API 將API 發布和管理整合到CI/CD 管線中

文章來源：NGINX

標籤