【翻譯】API開發如何提高效率:設計優先還是程式碼優先?

語言: CN / TW / HK

隨著api設計規範的普及,我特地花時間整理了基於歷史使用和最佳實踐構建API的最佳方法。API描述格式可以作為使用者可用的規範,來幫助理解如何最好地使用API。這個規範與計算機語言無關,人和計算機都可以閱讀,可以幫助簡化應用程式的抓取,和提高程式之間的可操作性。

設計優先與程式碼優先API開發

在使用API描述格式時,出現了兩個重要的思想流派:API開發的“設計優先”和“程式碼優先”方法。 程式碼優先是構建API的一種傳統的方法,在部署業務需求之後進行程式碼開發,最終通過程式碼生成文件。而設計優先提倡在編寫任何程式碼之前先設計API的規範,這是一種這幾年逐漸流行起來的新方法。 為了更好地理解這兩種方法,讓我們看看API生命週期的常見過程。和其他產品一樣,API的概念始於業務團隊識別一個機會。戰略分析師和其他業務人員會分析機會,並在文字文件中建立利用機會的計劃。然後將該文件傳遞給開發團隊,在開發團隊中,計劃採取了一些具體的形式。從現在開始,開發API有兩種可能: 設計第一:把計劃轉換成人和計算機都可讀的規範,例如生成程式碼的Eolinker文件 程式碼優先:根據業務計劃,直接編寫API,從中生成人和計算機可讀的介面文件,例如Eolinker自動生成文件 最後,在API執行之後,對其進行完整的測試,然後將其部署到合適的主機上。 這兩種方法都有其優點和缺點,最終,選擇正確的方法可以歸結為您希望用API解決的當下的技術和戰略需求。

設計優先——當開發人員的經驗很重要的時候

一個設計良好的API可以為您的API的採用和使用帶來奇蹟,使用設計優先方法可以更好地實現良好的設計。如果您的API策略涉及高度採用API並保留與API的整合的使用者,那麼良好的開發人員體驗非常重要。有效的API設計可以幫助終端使用者快速理解API的資源和價值主張,從而減少他們與API整合所需的時間。當與API整合時,具有一致設計的API降低了學習曲線,使其更有可能具有更高的重用價值和參與度。Eolinker開放平臺可以很好的幫助你做到這一點

應用場景 採用設計優先方法最多的情況是API的目標受眾是外部客戶或合作伙伴時。在這種情況下,API是一個關鍵的分發渠道,客戶可以通過開放的介面來使用為他們提供的服務,而良好的設計在決定客戶滿意度方面起著關鍵作用。 這些API在代表組織的服務方面起著至關重要的作用,特別是在全渠道生態系統中,資訊的一致性和不麻煩的消費是企業成功的一個重要指標。

程式碼優先——交付速度快的事項

如果開發人員直接從需求文件開始編寫API,那麼他們可以更快地實現API。如果您的市場策略強調速度和敏捷性是API程式成功的重要因素,這一點非常重要。在程式碼優先方法中自動化要容易得多,這有助於提高這種情況,許多庫支援伺服器程式碼、功能測試和部署自動化。

應用場景 程式碼優先方法以良好的開發經驗為前提,提供了速度、自動化和降低流程複雜性的功能。如果API供只需要構建API的團隊或公司內部使用,那麼程式碼優先方法是一個理想的解決方案。所開發的API很小並且只有幾個端點的情況,尤其如此。

總結

這兩種方法都有好的一面,也有差的一面。開發API的方法將在確定如何使用和維護API方面發揮至關重要的作用。您的API的最終使用者是誰?他們有什麼需要?你想用你的API程式來解決什麼?在選擇正確的API開發方法時,這些問題應該指導您的決策。

分享到: