api文档自动生成工具

最新推荐文章于 2024-10-10 07:14:36 发布

Shawn Yang XX

最新推荐文章于 2024-10-10 07:14:36 发布

阅读量1.5k

点赞数

分类专栏： Java 文章标签： java

本文链接：https://blog.csdn.net/weixin_42463980/article/details/82627789

版权

本文档介绍了如何集成和使用API文档自动生成工具，适用于Spring Boot和Spring MVC项目。详细阐述了安装步骤、配置选项，如扫描包设置、依赖添加，并解析了关键注解的用途，如@Api、@ApiModel等，帮助开发者快速生成清晰的API接口文档。

摘要由CSDN通过智能技术生成

安装教程

spring-boot集成：
1 添加依赖
- 添加依赖包

       <dependency>
            <groupId>com.gitee.sergius</groupId>
            <artifactId>api-generator</artifactId>
            <version>2.0.0</version>
        </dependency>

2 添加配置bean：

    @Bean
    public ApiComponent creatApiComponent(){
        return new ApiComponent()
                .addScanPackage("com.gitee.sergius.smarthome.intelligent.depot.restapi")
                .withYamlFilePath("D:/")
                .withParseDepth(3)
                .withServerHost("http://ip:host/")
                .build();
    }

addScanPackage：添加api扫描包，可以一次添加多个包，例如 addScanPackage（“com.package1”,“com.package2”）
withYamlFilePath:配置扫描完成后是否生成存储文件，该文件存储各个api信息，如果配置了该路径，当接口方法上面的方法tag变更之后，会保留之前的接口信息，这样做主要是为了可以做接口版本控制，如果不需要，可以不配置此项，此时如果修改了接口tag，之前的版本将不做保留。
withParseDepth：请求参数和返回参数递归扫描的层数，主要用来防止当请求参数或者响应参数配置中如果有循环嵌套的时候出现死循环。
withServerHost：此参数主要用来配置页面显示的接口请求路径的主机地址部分。

3 添加扫描的controller包：

  @ComponentScan("com.gitee.sergius.apitool.web")

spring-mvc集成：
1 添加依赖
- 添加依赖包

<dependency>
            <groupId>com.gitee.sergius</groupId>
            <artifactId>api-generator</artifactId>
            <version>2.0.0</version>
        </dependency>

2 添加配置bean：