Question

如何设计一个优秀的API（转载）

Answer 1

1、 面向用例设计
如果一个API被广泛使用了，那么就不可能了解所有使用该API的用户。如果设计者希望能够设计出被广泛使用的API，那么必须站在用户的角度来理解如何设计API库，以及如何才能设计出这样的API库。
2、 采用良好的设计思路
面向用例的设计，收集用户建议，把自己模拟成用户，保证API设计的易用和合理。
3、 避免极端的意见
在设计API的时候，一定要避免任何极端的意见。
4、 有效的API评审
API设计完成以后，需要经过周密的设计评审。
5、 提高API的可测试性
API需要是可测试的，测试不应依赖实现，测试充分的API，尤其是经过了严格的“兼容性整合测试”的API，更能保证在升级的过程中不出现兼容性问题。
6、 保证API的向后兼容
对于每一个API的设计者来说，都渴望做到“向后兼容”，因为不管是现在的API用户，还是潜在的API用户，都只信任那些可兼容的API。但向后兼容有多个层次上的意义，而且不同层次的向后兼容，也意味着不同的重要性和复杂度。