springboot实现Swagger配置

最新推荐文章于 2024-07-27 13:06:23 发布

墨笔之风

最新推荐文章于 2024-07-27 13:06:23 发布

阅读量438

点赞数 1

本文链接：https://blog.csdn.net/weixin_55685021/article/details/131565457

版权

文章介绍了如何在Springboot项目中集成Swagger，包括添加相关依赖、创建配置类Docket以及设置apiInfo，用于生成API文档。启动类中启用@EnableOpenApi注解，并提供了一个简单的日志输出，显示Swagger的访问地址。此外，提到了Springboot升级后与Swagger的兼容性问题，以及控制器和Vo层的注解使用。

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

springboot实现Swagger配置

直接上代码：

首先是依赖部分

在这里插入图片描述

导入相关依赖包

 <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

在创建一个配置类：

在这里插入图片描述

配置类：

@Configuration
@EnableKnife4j
@EnableOpenApi
public class SwaggerConfiguration {
    @Bean
    public Docket createRestApis() {
        return new Docket(DocumentationType.OAS_30)
                .enable(true)//是否启用：注意生产环境需要关闭
                .groupName("spring-boot-2.7.3")
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .ignoredParameterTypes(CookieValue.class)
                .apiInfo(apiInfo())
                .select()
                //以下拦截配置可以三选一，根据需要进行添加
                .apis(RequestHandlerSelectors.basePackage("com.example.page_demo.controller"))
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("支付宝小程序接口文档")
                .description("开发测试")
                // 服务条款URL
                .termsOfServiceUrl("https://www.baidu.com/")
                // 作者信息
                .contact(new Contact("auther", "https://www.baidu.com/", "123@qq.com"))
                .version("1.0.0")
                .build();
    }

}

启动类相关信息：

在这里插入图片描述

启动类：

@MapperScan("com.example.page_demo.mapper")
@SpringBootApplication
@EnableOpenApi
@Slf4j
@EnableWebMvc
public class PageDemoApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext run1 = SpringApplication.run(PageDemoApplication.class, args);
        ConfigurableEnvironment env = run1.getEnvironment();
        String sb =
                "\n**********************************************************\n" +
                "*                                                          *\n" +
                "*                     服 务 启 动 成 功                      *\n" +
                "*                                                          *\n" +
                "************************************************************\n" +
                "swagger: \thttp://127.0.0.1:" + env.getProperty("server.port") + "/swagger-ui/index.html#/" +

                "Version:" + env.getProperty("system.version") +
                "\n************************************************************\n\t";
        log.info(sb);
    }

}