在C#中为我的应用程序编写API

Question

我将编写一个应用程序,但我从未体验过允许人们使用我的应用程序编程接口.我的意思是我应该如何设计让人们使用来自外部世界的方法,如API.

请有人告诉我一个方法.我对此有点新意.

Answer 1

1. 尽可能少地暴露.您发布的每一位都将在下一版本中返回给您x100.保持兼容性非常困难.
2. 为您发布的所有内容创建抽象.您肯定会改变您的内部,但您现有的用户应保持兼容.
3. 将一切标记为内部.甚至是您的应用程序的主要方法.将使用每种可以使用的方法.
4. 以与接口相同的方式测试您的公共API.集成测试等.请注意,您的API将以不可预测的方式使用.
5. 最大化约定优于配置.这是必需的.即使您的API是单一方法,您仍然需要支持此方法.只是让你的生活更轻松
6. 签名,并强烈命名你的程序集,这是一个很好的做法.
7. 尽可能多地解决FxCop和StyleCop错误.
8. 检查您的API是否与您平台的命名准则兼容.
9. 提供尽可能多的示例,并记住您的API的大部分用法将是这些示例中的Ctrl + C和Ctrl + V.
10. 尽量提供文档.检查您是否没有GhostDoc样式的自动生成文档.每个人都讨厌这个.
11. 包括有关如何找到您的信息.
12. 不要混淆混淆.这将有助于您和您的用户.

添加

13. API应尽可能减少依赖性.例如,应禁止对IoC容器的依赖.如果您的代码在内部使用它.只需将它们插入装配体即可.

Answer 2

它可能不是最有趣的阅读,当然也不是唯一的阅读,但在设计你的类库(你的API)时,请不时地查看开发类库的设计指南,这是一个很好的想要有一个与.NET Framework自身对应的设计.