一致性，是否与系统中其他模块的接口风格一致，是否与对称接口的设计一致 。简单明了，API应该简单好理解，容易学习和使用的API才不容易被误用，给我们带来更多的麻烦 。
API尽可能少，如果一个API可以暴露也可以不暴露，那么就不要暴露他，等到用户真正有需求的时候再将它成为一个公开接口也不迟 。支持持续改进，API是否能够方便地通过扩展的方式增加功能和优化 。
5、提高API的可测试性API需要是可测试的，测试不应依赖实现，测试充分的API，尤其是经过了严格的“兼容性整合测试”的API，更能保证在升级的过程中不出现兼容性问题 。兼容性整合测试，是指一组测试用例集合，这组测试用例会站在使用者的立场上使用API 。
在API升级以后，再检测这组测试用例是否能完全符合预期的通过测试，尽可能的发现兼容性问题 。6、保证API的向后兼容对于每一个API的设计者来说，都渴望做到“向后兼容”，因为不管是现在的API用户，还是潜在的API用户，都只信任那些可兼容的API 。
但向后兼容有多个层次上的意义，而且不同层次的向后兼容，也意味着不同的重要性和复杂度 。7、保持逐步改善过去我们总希望能将 。
【怎么写api文档】
文章插图