编写API的建议

Question

我准备写一个api,并认为我会找到一些关于要注意的事情的好建议,如何写一个好的api.

我当然做了谷歌搜索,但除了Dustin Diaz http://www.dustindiaz.com/api-writing-tips/之外,我还没有找到好的建议.

在创建API时,您希望您做了哪些不同的事情？是什么造成了最大的不同.

我假设我要使用oauth.

我故意不提供api的详细信息,因为我正在寻找更多一般性建议,这些建议有望对更多人有用.

Answer 1

关键点我建议你看看:

• 实现RESTful接口
• 提供各种数据格式(JSON,XML等)
• 使语法直观且易于理解
• 完整的文档
• 使用适当的响应代码

此外,这里有一些您可能会觉得有用的链接:

http://www.slideshare.net/eaton/building-apis-that-rock
http://www.notiondesign.ca/blog/story/how-not-to-build-an-api/
http:// blog .apigee.com/category/api_best_practices/
http://blog.isnotworking.com/2007/05/api-design-guidelines.html

此外,这本书可以帮助您入门:

http://www.amazon.com/dp/0596529260/