Api 接口文档是什么？如何直接使用 ApiDoc 生成接口文档

api接口文档

现代化开发大部分都是一种前后端分离的开发模式，前端与后端分别独立进行开发。等后续再去统一的联调。前后端分离的开发模式下，前后端沟通的成本增加，如何减少口头的交流成了关键。这时有一份高端大气的接口文档就非常开心了。

是什么

一份描述了后端每个API接口的详细文档。主要需要如下几点信息：

1. 请求方式
2. 请求地址
3. 请求参数
4. 后端响应

这就引入一个新的问题，联调是什么，会出现什么问题？

联调

前端去在代码中去调用后台提供的api接口，并验证是否ok没问题。

联调会出现很多的问题：

1. 后台返回的数据用不上或者缺少数据
2. api接口调用不通，比如500 404
3. api接口跨域问题

（跨域产生的原因：域名、协议、端口有一个不同就会产生跨域。是浏览器的同源策略引起的）

针对跨域问题，该如何解决？可以参考以下文章:

如何写

1. 手写 word 、markdown、记事本都是可以的。
2. 通过一些工具来生成，省时省力。

使用步骤

1. 安装 apidoc（建议在当前项目下面安装）

$