第1章 API文档
API（Application Programming Interface）文档是描述如何使用代码库提供的功能的说明文档，包括接口的介绍，使用方法，参数等信息。良好的API文档，可以使开发人员更快的学习API的用法，并集成到他们的软件中。也可以给测试人员用于设计接口的测试用例，包括对功能，逻辑，异常等的测试。
1.1.包含哪些内容
API文档必要包含的部分有，接口名称，功能描述，参数说明（名称，类型，是否可选，说明），返回值说明（类型，意义），使用示例（针对单个接口或一组接口）等。
1.2.写给谁看
写给不同的角色，文档的侧重应该不同。需要在常规内容的基础上，对侧重的部分进行内容补充。
给开发人员看，让其更快的掌握模块提供的API用法，更快的集成。需要在文档中侧重代码示例，演示接口的调用顺序及调用方法。给测试人员看，用于设计接口的测试用例。要在文档中侧重参数的意义，参数的范围，返回值的意义等。
总之，API文档必要包含的部分有，接口名称，功能描述，参数说明（名称，类型，是否可选，说明），返回值说明（类型，意义），使用示例（针对单个接口或一组接口）等。