Spring Boot集成Swagger2

和blue一起变得更好

于 2021-09-08 17:11:10 发布

阅读量84

点赞数

分类专栏： Spring 文章标签： spring

本文链接：https://blog.youkuaiyun.com/m0_46762668/article/details/120184290

版权

Spring 专栏收录该内容

14 篇文章

订阅专栏

该博客展示了如何在SpringBoot应用中配置Swagger2，创建RESTful API的详细文档。通过`@Configuration`和`@EnableSwagger2`注解启用Swagger，并定义`Docket` Bean来指定API包路径和路径选择器。访问`swagger-ui.html`可以测试每个接口，支持多种HTTP方法。这是一个关于API文档自动化和接口测试的教程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.创建类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.jsu.ww.controller")).paths(PathSelectors.any()).build();
        //指定构建api文档的详细信息方法:apiInfo()

    }
    /**
     * 构建api文档的详细信息
     * @return
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //设置页面标题
        .title("Spring Boot集成Swagger2接口总览")
                //设置接口描述
        .description("第一个swagger接口测试")
                //设置联系方式
        .contact("2824768523@qq.com")
                //设置版本
        .version("1.0")
                //构建
        .build();
    }
}

访问网址:http://localhost:8080/swagger-ui.html
主界面
每个接口可测试如下:
每个方法有五种测试方法,可以通过postman测试
在这里插入图片描述