标签：仓库 代码 生成 API 文档 Eolink Swagger
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
标签：仓库,代码,生成,API,文档,Eolink,Swagger 来源： https://www.cnblogs.com/apibest/p/16561707.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。