%20(2).svg)
项目简介
本项目是基于Spring Boot框架开发的API文档生成工具，其目的是助力开发者快速生成与维护API文档。借助注解和配置，开发者能为Spring Boot项目便捷地生成详细的API文档，还支持多平台（如Android、iOS、Vue等）代码生成，同时提供丰富的文档格式（如Markdown）。
项目的主要特性和功能
- 支持生成Android、iOS和Vue平台的代码示例。
- 可生成Markdown格式的API文档，方便阅读与维护。
- 具备参数校验功能，保证API请求参数符合预期。
- 支持全局配置API的参数和返回值，简化开发流程。
- 通过注解标记API的类、方法、参数和返回值，自动生成文档。
- 支持不同环境（开发、测试、生产）的配置。
- 提供全局和局部状态码管理，便于API错误处理。
安装使用步骤
1. 添加依赖
在项目的pom.xml文件中添加以下依赖：
xml
<dependency>
<groupId>com.citrsw</groupId>
<artifactId>java-api-docs</artifactId>
<version>1.6.4</version>
</dependency>
2. 配置Spring Boot启动类
在Spring Boot启动类上添加@ApiEnable注解，并按需配置相关属性：
java
@ApiEnable(name = "项目名称", actives = {"dev", "prod"}, paramVerification = true, paramHandle = ApiParamHandle.EXCEPTION, paramOutput = true)
@SpringBootApplication
public class ApiExampleApplication {
public static void main(String[] args) {
SpringApplication.run(ApiExampleApplication.class, args);
}
}
3. 使用注解标记API
在Controller类和方法上使用注解标记API，示例如下： ```java @ApiClass("用户管理") @RestController public class UserController {
@ApiMethod("获取用户信息")
@GetMapping("/user/{id}")
public User getUser(@PathVariable @ApiParam(description = "用户ID", required = true) Long id) {
// 业务逻辑
}
} ```
4. 访问API文档
启动Spring Boot应用后，通过以下URL访问生成的API文档：
http://ip:端口/项目名/citrsw/index.html
5. 生成Markdown文档
通过以下URL下载生成的Markdown格式的API文档：
http://ip:端口/项目名/citrsw/api/down/markdown
按照上述步骤，即可为Spring Boot项目轻松生成详细的API文档，并支持多平台和格式的代码生成。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】