我應該考慮爲我正在構建的新網站創建API的幾點？

Question

建設一個網站時我應該考慮什麼要點，並且計劃用API來支持用戶使用？

我看到，最有名的網站都爲開發人員提供了一個API來處理，如Facebook，Twitter的，谷歌....

有，而建設一個新的網站，我應該考慮任何一般分能夠使用API​​支持開發人員？ 「只是非常一般的點，無論網站服務自己」

UPDATE下面的所有答案幫了我很多。

Answer 1

我推薦Joshua Bloch的「如何設計一個好的API及其重要性」的互補PDF和presentation。

Answer 2

我想你會開始識別網站支持的功能（例如，addUser，addStory，addComment，editXYZ等，取決於網站的類型）以及它提供的數據（getCommentsForStory，getStories， getUser，...），併爲這些函數創建一個Web服務API，並進行適當的安全檢查等等。

如果您已經對網站進行了良好的編碼，將Web服務圖層放在網站功能前應該非常簡單（這只是控制器和模型的另一種視圖）。

Answer 3

SOAP或XML

根據您的應用。如果它很複雜，你可能需要肥皂的功能。 KISS應該特別適用於API。有一個合理的URL佈局有道理在資源方面：

www.site.com/people/london 

作爲一種資源。

http://en.wikipedia.org/wiki/Restful

查找到爲什麼使用PUT，POST，GET和其他人是很重要的。

好運

Answer 4

一件簡單的事情，這可以爲您節省很多的麻煩，在未來 - 包括「API版本」作爲您的URL的一部分，類似的東西..

www.example.com/api/v1/getAnswers/ 

如果當您決定修改您的API時，您不必擔心所有URL向後兼容（打破現有應用程序），您的用戶只需開始使用/api/v2/，並最終貶低舊版本。

其中，del.icio.us和github都做到這一點

Answer 5

最有說服力的理由，國際海事組織，提供的API爲您的網站提供的信息和/或人們纔會有動力通過編程進行交互的服務。既然你無法阻止這種情況（儘管許多網站所有者的希望和夢想），但最好接受它，因爲提供API意味着人們可以準確訪問他們想要的信息/服務，從而減少系統負載。

Answer 6

構建一個好的api很難，需要大量的練習。

您創建的第一個API應該是您的敵人的網站的API。

第二個API是你的朋友的網站。

您建立的第三個API爲您的客戶。