SpringBoot3.2.0和Springboot2版本整合Swagger_springboot3.2 swagger

Springboot3.2.0版本中不在支持swagger2的格式。

以下提供springboot2版本和Springboot3版本下的swagger依赖

SpringBoot2.X 需要配置config

、、、、、、、、、这个有ui界面   这是springboot 2 项目 需要配置swagger2文件
 
<!-- 引入 swagger-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.7.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.7.0</version>
    </dependency>

配置信息

@Configuration
@EnableSwagger2
public class Swagger2Config {
 
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2);
    }
}

Springboot3.X版本 无需任何配置

、、、、、、、、、、  这个是springboot3项目 没有任何配置直接使用  
 
<!-- 引入 swagger-->
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.0.2</version>
        </dependency>
 
        <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
        <version>2.0.2</version>
        </dependency>

 然后启动成功后直接登录 http://ip:post/swagger-ui.html即可

需要注意的是swagger中2版本和3版本的书写格式不同，用法完全相同

从Springfox迁移过来的，需要修改注解：

@Api → @Tag

@ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden

@ApiImplicitParam → @Parameter

@ApiImplicitParams → @Parameters

@ApiModel → @Schema

@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)

@ApiModelProperty → @Schema

@ApiOperation(value = "foo", notes = "bar") → @Operation(summary = "foo", description = "bar")

@ApiParam → @Parameter

@ApiResponse(code = 404, message = "foo") → @ApiResponse(responseCode = "404", description = "foo")

正常情况下只需要注意 Api和ApiOreration  和 Tag 和Operation（summary = “XXX”）即可