接下来要有当前文档的版本修订信息 ， 即为历史修订信息 ， 应当包含基础的信息有：版本号、修订日期、修订人、修订说明等 。
开始编写文档的目录结构 ， 注意大标题和小标题的使用 ， 需要合理的运用说明 。首先当然是文档的说明信息 ， 再来是一些准备信息和流程信息 ， 然后开始接口说明 ， 最后可以有举例、常见问题、注意事项、响应码的说明信息等等 。
下面开始按照文档的目录结构逐一进行详细的介绍说明 ， 比如文档说明的介绍 ， 用高效简洁的语言明确的说明文档信息 ， 注意文档中大标题应当字体大小样式一致 ， 小标题也应当字体大小注意保持一致 。
简单的说明技术资料获取及准备 ， 确认调用系统信息比较重要 ， 需要确认编码格式 ， 防止乱码 ， 确认当前的文档版本是否是要使用的版本 ， 否则白做无用功 ， 项目的搭建环境简单说明即可 。
开始说明接口的调用流程 ， 如何调用接口 ， 需要做的一些准备 ， 说明引入相应的依赖以及配置需要配置的文件 。
现在可以开始接口的说明 ， 接口的说明信息应当包含接口的名称 ， 接口的地址 ， 接口的协议 ， 然后针对当前接口下的方法说明 。
方法的说明应当包含方法的描述 ， 即其作用 ， 方法的请求参数说明 ， 以及响应的参数说明 ， 参数说明应当包含参数的类型 ， 参数名称 ， 参数的含义 ， 并且备注参数是否必须传递 。
9
接口说明完之后 ， 就是文档的末尾 ， 有注意事项添加一些注意事项 ， 或者附录说明 ， 添加标注 。
5. 什么是接口,怎么调用一个类 接口其实就是一个类bai 但是里边的方法只是声明了 都没有实现。
所以用的时候du 你就得创建一个类来实现这个接口里的全部方法 。zhi
List就是一个接口类 ArrayList就是一个dao实现接口List的类 。
也不能说是调用类吧 算是使用类 只要专new一个类对象就可以了哈、
比如 创建一个队列 List list = new ArrayList（)；创建的这个
list就是一个ArrayList对象 。
实现接口的类很多 同样实现List的类也不只就属是ArrayList ， 也有别的哈！
文章插图