在软件测试工具Eolink中API接口测试多种方式生成接口文档:通过手动创建,进行API测试后的测试数据直接保存为新的API接口文档,从Postman,apidoc,swagger,等平台导出的文件再导入到Eolink中等等方式都可以创建API接口文档,这些方式适合于一次性文件进行导入,但当需要根据代码仓库批量性的导入API文档就需要使用另一个,功能自动生成API文档,填写好相关的导入信息就可以进行导入,在代码仓库发生变化是点击同步即可进行同步修改的信息。该功能支持通过Swagger URL、apiDoc、Github等方式导入,本文章主要介绍通过Gitlab导入。

通过扫描Gitlab代码方式导入,支持swagger和apiDoc注解方式。如何扫描文档生成文档?
首先什么是注解,注解就是一种标签,可以插入到源代码中,我们的编译器可以对他们进行逻辑判断,或者我们可以自己写一个工具方法来读取我们源代码中的注解信息,从而实现某种操作。需要申明一点,注解不会改变编译器的编译方式,也不会改变虚拟机指令执行的顺序,它更可以理解为是一种特殊的注释,本身不会起到任何作用,需要工具方法或者编译器本身读取注解的内容继而控制进行某种操作。
再者什么是元数据。元数据(meta-data)就是指用来描述数据的数据,它往往是以标签的形式出现,主要用于描述代码块之间的联系。我们的注解就是一种元数据,根据它所起到的作用。
而Eolink就充当以上说明中的工具的作用,扫描注解和元数据进行判断,生成API接口文档。
需要填写信息说明
1. 代码仓库地址:GitLab 有线上版本和用户自己搭建私有云版本,线上版本可以填写 https://gitlab.com,如果是自己部署的 GitLab 则写域名或者IP端口
2. 项目 ID:GitLab 中的 project ID
3. 访问私钥:可以通过 GitLab 的 Access Tokens 功能获取
4. 需要扫描的 API 目录路径:默认为 master 分支,也可以选择实际需要扫描的代码分支
5. 需要扫描的数据结构目录路径:API 层相关代码的存放路径,例如:src/main/java/com/example/demo/controller
6. 需要扫描的数据结构目录路径:数据结构相关配置信息的存放路径,例如:src/main/java/com/example/demo/model
7.目标语言支持Java 或 PHP
填写好信息既可以进行同步。

总结:
通过扫描代码注释自动生成API文档,可以快速生成API文档,在代码发生变动后也可以一键同步,可以减轻大部分不必要的工作量。
想要了解更多eolink相关信息可以到:www.eolink.com