如何快速编写api文档
刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一、请求参数
1. 请求方法
GET
POST
PUT
DELETE
其他
application/x-www-form-urlencoded
application/json
application/xml
multipart/form-data
用于获取数据
用于更新数据，可与PUT互换，语义上PUT支持幂等
用于新增数据，可与POST互换，语义上PUT支持幂等
用于删除数据
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
请求参数使用“&”符号连接。
内容为json格式
内容为xml格式
内容为多个数据组成，有分隔符隔开
4. HTTP Body
描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例：
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样，需要描述请清除数据的类型。
另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例（重点都用红笔圈出来，记牢了）：
五、接口工具
推荐使用的是http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
这里所用到的工具就是javadoc2chm.百度”javadoc2chm“下载。我看到有一个1积分下载的，我这里也有，需要的话可以私聊。
2
javadoc2chm.exe的大小只有102k左右，谨防上当受骗啊。
3
使用javadoc2chm制作帮助文档的时候，首先下载的文件中有帮助文档的html版。例如我下载的Struts2就有doc目录。
4
打开javadoc2chm.exe. path to javadoc是用来选择doc的路径的，output filename是用来给输出的chm一个名字，以.chm结尾，title是打开chm后首页的文字
5
我这里以制作Hadoop2.7.1的帮助文档实例。选好目录后，点击Go就开始只做了，制作完成后，go按键变黑色可用，只做好的chm文档存放在你选择的html帮助文档的目录里。
END
注意output filename是用来给输出的chm一个名字，以.chm结尾如果不是，输出后改一下
工作愉快！点赞啊。
注意事项
