可見的 API 會被重複使用,而非重新發明

  2023 年 4 月 4 日

SmartBear API 技術推廣人員 Frank Kilcommins 拜訪了 Stack Overflow Podcast,談論了關於 API 生命週期以及 API 規格如何協助開發人員了解您的 API。繼續閱讀以了解更多關於他在訪問期間所談論的內容。

API 為每個產業的創新注入動力,並讓每個人都能存取新的功能。然而,這並不代表您可以隨便推出一個 API 並期望它成功。可見性對於任何 API 的成功都至關重要 – 但您如何確保您的 API 可見?

專注於良好的 API 設計

API 消費者希望從快速尋找和發現 API 中獲益,而 API 提供者需要為他們建立一個可瀏覽和互動的組合。這些 API 的消費者可以是開發人員、產品經理,甚至是業務分析師。

這個過程聽起來很簡單,但事實證明對所有這些角色來說都是一個挑戰。API 提供者必須專注於 API 設計,確保其可用且可存取。入門以存取 API 並探索其介面的體驗也至關重要。一旦 API 消費者找到並與 API 互動,他們就會立即想了解其價值和限制。API 是否易於使用?API 是否滿足其業務需求?自行建置是否更容易?

如果可以快速且輕鬆地評估 API,API 消費者就會發現整合預建的 API 將加速他們的軟體開發生命週期,節省時間和資源,並減少錯誤。

提高可探索性

在交付 API 時採用設計優先的方法,允許開發人員使用已存在的規格並聲明 API 的品質。

為此,利用了解現有常見規格的工具(例如 SmartBear 的 SwaggerHub)可以為您的 API 在設計過程中應如何呈現解鎖標準化的樣式指南。從那裡,團隊可以開始建立 API 目錄,以便根據不同的屬性和業務價值產品輕鬆發現 API。

這將確保它們將在整個組織中使用。如果 API 沒有被使用,那麼它就不會帶來任何價值。如果它沒有帶來任何價值,那就沒用了。

了解 API 的重要性

在整體查看 API 生命週期時,重要的是要了解組織內部的策略願景,了解使用特定 API 所解決的問題。

您將該問題帶入構思階段,將其帶入設計中,並協作以獲得關於 API 是否解決了原始業務需求的意見回饋。同樣,使用像 SwaggerHub 這樣的工具允許團隊使用不同的規格(Swagger、OpenAPI、AsyncAPI)與不同的利害關係人協作進行 API 設計。

協作努力的成果讓其他團隊可以開始他們開發 API、測試它並最終部署它的工作。

API 探索

一旦 API 部署,API 提供者希望使用者找到其價值,而 API 消費者則希望發現有價值的 API。為了了解 API 的價值,使用者需要一個專注於無摩擦探索的工具。

SmartBear 的新工具 SwaggerHub Explore 立即視覺化 API 資料,以便在投資 API 整合之前,了解 API 在一個地方提供的功能和限制。這個新的免費工具支援多協定 API,包括以 Kafka 為導向的事件驅動端點和 Restful API。

為了最有效地使用 API,您必須了解 API 的行為方式。SwaggerHub Explore 是一個易於使用的介面,可立即為您的 API 工具組提供價值。

重點

API 探索和瀏覽是一個需要時間的過程,但絕對值得努力。當您努力在組織中建立 API 經濟時,您需要能夠在其整個生命週期中尋找、瀏覽和管理 API。這將有助於確保它們成功,並可以為方程式兩邊的使用者提供價值:想要存取新服務的開發人員和需要來自其組織或產業部門的資料饋送的操作員。

收聽該集以了解更多 Frank 的觀點

https://stackoverflow.blog/2023/03/15/visible-apis-get-reused-not-reinvented/ 

立即試用 SwaggerHub Explore:軟體測試、監控和開發人員工具 - 免費試用 | SmartBear