設計一個成功的API程序的10條法則

早在上世紀90年代中後期,互聯網是一個奇怪的、但不斷增長的生態系統。企業意識到了這種潛力,一些企業實際上知道如何利用這種潛力。然而,人人都知道的一件事是,上網是必要的。他們不知道確切的原因,許多人只是用它作爲一個目錄來提供一個電話號碼和地址,但有一個明顯的需求。與新技術一樣,這種緊迫感促使許多公司在知道目標是什麼之前就在網上建立了自己的形象。

如果你想笑10分鐘,去http://archive.org/web/看看過去的網絡。除了設計,你還會意識到它的質量和實用性是多麼的差。隨着時間的流逝,期望值呈指數級增長。很快,公司意識到僅僅因爲你的競爭對手創建了一個網站就不是一個計劃。最好是花幾個月的時間想出一個策略。這是大多數網絡創新的標準;先設計再計劃,再發展。

20年後,我們又看到了api的發展趨勢。acronym API有點用詞不當,因爲它字面上的意思是“應用程序編程接口”,但它創建的目的是描述與現在使用它不同的東西。我們現在通常稱爲api的是內部微服務,它們向其他人公開以供構建。現在有一些企業公司在沒有完全理解用例或業務需求的情況下快速地構建api。

簡單地構建一個API並不能保證在當今市場上的相關性。如果你看看有多少公司打開了一個API,然後又關閉了它,你會發現很多公司意識到創建一個API的簡單行爲並沒有使它變得有用。API是必須從各個角度考慮的業務和產品決策。下面,我們列出了成功API程序的10條規則,因爲簡單的“存在”並不是勝利。你最終會看到一個1997年的網站,裏面充滿了動畫gif和聲音效果。建設未來,而不是現在。

API的10個規則

知道你爲什麼這樣做。在開始編寫代碼之前,請了解爲什麼需要一個API程序。這通常被稱爲業務用例,或者甚至是用例。知道確切的目標是什麼,這樣你就知道你在朝着什麼目標前進。

知道你在做什麼。讓你的團隊學習和學習最好的技術和慣例。api是一個開放的世界,但是使用常用的約定可以節省大量的時間和費用。速記:使用REST和JSON。

知道你的工作流程。由於您不是您正在構建的api的用戶,所以請記住,任何更改都可能破壞其他人的工作。明確你的工作流程,隨時更改通知,支持向後兼容。文檔是關鍵!

知道你的數據(又名記錄一切!)跟蹤任何事件、失敗或奇怪的情況。不要發現自己處於一個人人都討厭的API發佈的位置,你是唯一一個不知道的人。

構建/購買困境。一些特性,例如身份驗證,可能是一個複雜而敏感的問題。考慮將它們委託給API管理工具,比如Mashery或Oracle。

你的API文檔。您不能僅僅通過觀察就指望第三方來確定您是如何設計API程序的。要讓社區和/或第三方成功地使用您的API構建,需要大量的文檔。

測試API生成的構件。測試生成API的代碼就像假設食物的成分是好的一樣。驗證輸出更乾淨更簡單。它保證你至少滿足質量控制的最低要求。此外,您還可以獲得API測試報告的記錄,從而更容易地診斷出意外錯誤。

監控API的性能和可用性。API質量控制的第二個(但不是第二個)方面是知道服務什麼時候運行良好。這對於API所有者幫助診斷服務中的任何缺陷以及API使用者(他們將決定何時以及爲何他們的產品出現問題)來說都是至關重要的

打開耳朵和睜開眼睛。確保測試和監控工具能夠在發生問題時及時通知您的員工。一個好的正常運行時間記錄只有當問題出現時,你的反應纔有效。

資源和費用。測試活動對於您已經被徵稅的開發團隊來說非常耗時。在許多情況下,依靠外部專家和顧問可能比內部資源更便宜和更可靠。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章