開放API

開放API,API是應用程式編程接口的意思,開放API就是開放應用程式編程接口。如果說程式開放API就是說開放接口,以讓別人的程式能夠調用你的程式數據。就像你的電腦、手機等有一些USB接口,也可以說是開放了接口,有了這些接口別人就可以用他來做插隨身碟,充電等之類的功能。

開發方法
如果你發布了一個開放API,而它卻難以集成,且沒附有相關標準,或附有標準但卻不適合,那么就不會有開發人員使用這一系統。確保你的API可以為人使用的最佳方法是在你自己的應用程式中使用它,就是俗語所說的“自產處用”。
決定使用哪一個API標準很重要,因為每一API標準的目標人群都很特別。如果你想支持大量的用戶,那么就使用一個簡單的API,這並不需要多大的開銷,如RESTful API。REST標準非常廣泛。最好的做法是確保你的API是一致的。例如,我沒有使用SOAP,因為它過於複雜。
SOAP是構建基於Web 的API的主要協定,但與之REST和JSON相比,它過於陳舊。我發現,讓JSON取代SOAP和XML來做為回響可以使生活變得更簡單。JSON讓我返回一個簡單的對象格式,它幾乎可以以任何語言解析。
為了認證(如OpenID,OAuth和SAML),給常見的API附上標準可以讓你的API容易為開發人員和非開發人員所使用。如果你不為用戶處理認證問題,就要使用簡單的基於HTTP的或基於令牌的身份驗證來取代OpenID、OAuth或SAML,他們設計的主要目的是作為用戶進行身份驗證。
另外,提供一個自身已經存檔的開放API對於開發人員是有益的。我最近開始在我的API中添加Swagger API文檔。Swagger允許開發人員為API自動產生代碼,這些代碼可以多語言的。如果你沒有遵循這一方法,你至少要確保你提供了API客戶庫使用是最流行的語言,如Java、Node.js、Python、Ruby和面向對象C(它是用於開發移動套用的)。
關鍵是要遵循簡單的軟體信條和標準。不要重新創造API,不要把認證複雜化。

相關詞條

熱門詞條

聯絡我們