设计客户端API的最佳方法是什么?

时间:2010-02-21 18:06:13

标签: api

我经常需要设计客户端API供其他程序员使用。语言可能有所不同,包括Ruby,Java,Erlang和Javascript(Mootools)。有没有人有关于创建一个非常有用的API的任何提示。是的,这个“是”一个非常主观的问题,我想这样我可以让其他人更容易使用我的API。

6 个答案:

答案 0 :(得分:1)

注意这个: http://video.google.com/videoplay?docid=-3733345136856180693#

要添加详细信息,这是由Josh Bloch提供的演讲视频,他是Google的高级Java人物。如果您想要了解制作API时要考虑的问题,那就太棒了

答案 1 :(得分:1)

我强烈建议您遵循Joshua Bloch的建议:Joshua Bloch - How to Design a Good API and Why it Matters。它可以在PDFVideo中找到。

答案 2 :(得分:1)

一些想法:

  • 使您的方法名称具有描述性
  • 使用文档清楚地指出参数和返回值
  • 关注YAGNI和KISS
  • 没有什么比代码示例更有帮助了......很多都涵盖了很多用例

答案 3 :(得分:1)

我建议您阅读Trolltech /诺基亚人员的以下内容:

<强> The Little Manual of API Design

答案 4 :(得分:1)

如果您对某些非免费替代品感兴趣,那么下面的书将是一个很好的建议:

Practical API Design: Confessions of a Java Framework Architect by Jaroslav Tulach

答案 5 :(得分:1)

如果您的主要目标之一是制作可用的 API,或者换句话说,提供良好的开发者体验,那么您可能应该查看以下列表资源(api可用性和开发人员体验资源):http://www.apiusabilitytesting.com/resources/