接口文档主要讲清楚几个事，第一是接口说明，比如这个接口是干什么的，第二是参数要求，比如传给接口的值有哪些，第三是请求方式，是用get还是post，第四是示例，比如怎么调用，第五是错误码，出问题时的提示，第六是更新记录，告诉用户什么时候改过。网上找的接口文档都差不多，像查天气的接口，文档里肯定有温度湿度这些参数，还有用get请求的说明，错误码500就是服务器出问题了。

为什么这样分呢？因为接口文档就是给开发者用的工具书，得把每件事说清楚。比如参数要求这部分，网上80%的文档都写了必填项和可选项，像发用户注册的接口，手机号和密码是必填的，头像是可选的。错误码部分也很关键，像支付接口返回200是成功，401是没登录，500是系统崩溃。网上有80%的接口文档都包含这六类信息，像“天气查询”的文档里，参数有温度、湿度，请求方式用get还是post要看接口定义，错误码有500表示服务器问题，更新记录写的是前年10月改了返回格式。有些文档还加了个调用频率限制，比如每小时只能查10次，这个算额外信息。所以总结下来，接口文档就是把这些都要列明白，让调用的人不会搞错。