【源码】基于Spring Boot和Aglio的API文档生成工具

项目简介

本项目是基于Spring Boot框架和Aglio工具的API文档生成工具，可帮助开发者自动生成API文档和测试用例，支持导出多种API文档格式，如API Blueprint、Postman、JMeter等。开发者能通过命令行或IDE插件，将项目的API文档轻松导出到指定目录。

项目的主要特性和功能

1. API文档生成：支持生成API Blueprint格式文档，并利用Aglio工具转换为HTML格式。
2. 测试用例生成：支持生成Postman和JMeter格式的测试用例。
3. 多项目支持：可分析Maven、Gradle和自定义的Java项目，提取API信息。
4. 命令行工具：提供命令行工具，便于开发者通过命令行生成API文档和测试用例。
5. IDE插件：支持IntelliJ IDEA插件，能在IDE中直接生成API文档和测试用例。
6. 自定义配置：允许开发者通过配置文件自定义分析和导出选项。

安装使用步骤

1. 安装依赖

• 安装Aglio：通过npm安装Aglio工具，用于将API Blueprint文档转换为HTML格式。 sh npm install -g aglio
• 安装Gradle：建议使用Gradle 6.8版本进行项目构建，可从Gradle官网下载并安装。

2. 进入项目目录

sh cd turtle

3. 编译项目

使用Gradle进行项目编译： sh gradle build 编译完成后，在./build/distributions目录下会生成压缩包turtle-1.0.2.tar和turtle-1.0.2.zip。

4. 配置环境变量

将生成的压缩包解压到任意目录，并配置环境变量： - Mac系统：将以下内容添加到~/.bash_profile配置文件中： sh export TURTLE_HOME=你的目录/turtle export PATH=$PATH:$TURTLE_HOME/bin 重新加载配置： sh source ~/.bash_profile - 验证配置：执行如下命令，返回字符串Turtle version 1.0.2，说明配置成功： sh turtle -v

5. 生成API文档

在项目目录中执行如下命令，将项目的API文档导出到./out目录下： sh turtle -e blueprint

6. 生成测试用例

支持生成Postman和JMeter格式的测试用例，通过以下命令生成： sh turtle -e postman turtle -e jmeter

7. 使用IDE插件

若使用IntelliJ IDEA，可将turtle-1.0.2.zip导入到IDEA中作为插件使用。通过IDEA的插件菜单，可直接生成API文档和测试用例。

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】