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 类型的数据,否则就会提示无法访问。