项目协作，如何写好API文档

什么时候需要API文档

1. 开发中，前后端经常需要接口联调、功能对接、两个人的开发节奏不一致，这时候就需要API文档。
2. 远程协作，两个人沟通不便，一个好的文档是很有必要的，可以省去很多不必要的沟通。
3. 人员离职，新人接手项目，如果没有文档，你只能通过看代码来了解接口的参数和调用方法，这种时候API文档就很有必要了
4. 测试人员测试时，需要按照API文档来测试接口的可用性

编写API文档的痛苦

编写API文档，对于大多数开发者而言，都是痛苦的，很多人还在用txt、word、markdown这类编辑器来写，编写很麻烦，如果有多层级的子参数，更加是不知道如何表达好。 每次写完文档，还要手动同步给不同的协作者。

选用好工具

网上已经有很多API的编写工具了，我体验了十几个这类工具，但是大部分都还是在用markdown编写，编写体验都不好，预览效果也不够优雅。经过各种对比使用，我推荐大家使用 易文档，直接看效果：签到文档， 官方示例文档，易文档他有http专属的编辑器，编写特别方便，全程可以只用键盘搞定，还支持接口在线测试，一键生成mock

掌握好技巧，编写简单快速

易文档官方有提供各种 技巧教程，只要大家掌握好这些技巧，文档的编写就变得很轻松了