API 文档的编写让许多 API 编写人员感到头疼，主动生成 API 文档就能协助咱们省心省力地完成任务。
所以今天咱们来经过 Eolink 来演示怎么经过 API 办理工具实现 API 文档主动生成。
Eolink 是一款转为开发者设计的 API 协作平台，经过 API 研制办理平台能够实现规范办理、测验一切 API ，主动生成 API 文档，统一办理 API 相关数据，协助团队内部共享工作成果等多种功用。
从 Swagger URL 中扫描 API 文档
用户能够给项目关联 Swagger 生成的 JSON 文件地址，Eolink 的 API 研制办理能够远程读取 Swagger JSON 并主动生成 API 文档。
- 进入 API 办理与测验，选择项目，点击左边栏的其他能够看到 API 文档生成。
- 点击增加来历，在弹窗中选择经过 Swagger URL 生成 API 文档，然后点击下一步：
- 输入 Swagger 生成的 JSON 地址。
这里需要注意的是，该 JSON 地址需要能够经过网络拜访，而且该地址返回的数据需要是 JSON 类型的数据，否则就会提示无法拜访。
- 装备完成后，界面会提示装备完成。此时您能够经过在当前页面页点击 同步 按钮，或许经过 Open API 触发同步操作。
从代码库房中扫描 API 文档
用户能够给项目关联代码库房，API 研制办理平台 能够远程读取库房中的代码注解并主动生成 API 文档，能够识别 Swagger 2.0 的代码注解格式。
现在支持的库房类型有：Github、Gitlab、码云。
- 进入项目页，点击其他，再点击 API 文档生成增加来历 ，在弹窗中设置需要扫码的代码库房，点击当即同步即可。
GitHub
其间 Github 代码库房的信息阐明如下图：
Gitlab
Gitlab 代码库房运用信息如下图：
码云
码云代码库房运用信息如下图：
能够依据 不同需求自行选择三种不同类型的代码库房，远程读取库房中的代码注解并主动生成 API 文档，不再需要编写人员手写文档。
咱们能够看到，无论是从 Swagger URL 中扫描 API 文档，还是从代码库房中读取代码注释直接生成 API 文档，运用 Eolink 的 API 研制办理平台是一个非常不错的选择，简单快捷且功用强大，减轻大部分不必要的工作量。
如有爱好可自行在线试用：www.eolink.com
