turtle

项目说明

本项目的主要目的，是提供一个生成API文档和测试用例的工具。

如何使用

安装依赖

• 安装并配置aglio

手动编译

• 安装并配置gradle，建议使用gradle 6.8版本。

gradle build

• 使用上述脚本编译后，在./build/distributions目录下，可以看到编译出来的压缩包turtle-1.0.2.tar和turtle-1.0.2.zip。

turtle-1.0.2.zip可以导入到IDEA中，作为IDEA的插件使用。

• 将任意一个压缩包放到你想放到的任意目录下。
• 解压并配置环境变量：

如果是Mac系统，将以下内容添加到~/.bash_profile配置文件中：

export TURTLE_HOME=你的目录/turtle
export PATH=$PATH:$TURTLE_HOME/bin

重新加载配置：

source  ~/.bash_profile

执行如下命令，返回字符串Turtle version 1.0.2，说明配置成功：

turtle -v

• 在你的项目目录中执行如下命令，即可将项目的API文档导出到./out目录下。

turtle -e blueprint

代码架构

• 通过命令行或IDE的Plugin获取源代码信息；
• 通过Processor进行处理，其中Analyzer进行源数据分析、Collector进行API数据收集，得到完整的API信息，再由Notifier发出通知；
• 最后由Exporter导出不同的API文档（或测试用例），或将API信息（或测试用例）导出到不同的工具、系统中。