共计 890 个字符，预计需要花费 3 分钟才能阅读完成。
开发 API 必然少不了编写 API 文档，API 文档所波及的点太多，在编写时不仅要思考到文档的完整性，同时还须要思考到文档的可读性。
完整性包含 API 的申请参数、响应后果、示例等等。API 文档就像一份说明书，须要记录 API 的整机（API 由什么形成），还须要记录 API 如何应用，并且应用时遇到的问题是否是失常的。
就像说明书一样，API 文档会有不同的人查阅，这其中包含公司内部人员与内部用户，内部人员包含开发人员、测试人员、运维人员、经营等，而内部用户包含合作伙伴，一些云 API 还蕴含各种各样的须要应用云 API 的用户，例如地图 API，须要面向企业开发者或者集体开发者、学生等。而这些用户的技术水平参差不齐，所以文档的可读性是 API 文档编写者须要特地留神的。
API 文档工具
工具是 API 文档编写者的福音，一款好的 API 文档工具能缩小 API 编写的工作量，并且优化团队的沟通效率。在这里举荐的是 Eolinker，应用了也有两年了，从刚开始集体测试到起初的团队合作，始终在用这款工具。本文介绍一下该工具的 API 文档局部性能。
导入性能
在 Eolinker 能够对多个平台我的项目进行导入，该性能能够疾速创立已有的我的项目。
API 文档
除了导入，还能够在 Eolinker 增加新的 API。在新增 API 界面，该工具提供了 API 所需内容的表单，把 API 信息填入表单后，即可查看 API 文档。
API 文档界面能够看到该 API 的所有信息。还能够设置 API 变更告诉，查看 API 版本与变更历史，对 API 进行评论等。
我的项目分享
我的项目分享有两类，一种是在线分享，一种是离线文档，可依据不同用户须要进行分享文档。
在线分享性能能够生成分享连贯，在浏览器关上后能够实时查看到我的项目内 API 的停顿。
离线文档反对多种格局导出，应用起来十分不便。
以上是 Eolinker 从创立 API 到分享 API 的简略介绍，从界面能够看出 Eolinker 所生成的 API 文档简洁、具体，性能也很全面。感兴趣或者须要应用管理工具治理 API 的，能够思考应用看看。
应用地址：[www.eolinker.com(https://datayi.cn/w/4PK51zZ9)