SpringBoot集成SwaggerUI

最新推荐文章于 2023-12-18 17:57:12 发布

原创最新推荐文章于 2023-12-18 17:57:12 发布 · 954 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot #SwaggerUI

SpringBoot 专栏收录该内容

68 篇文章

订阅专栏

本文详细介绍如何在Spring Boot项目中集成SwaggerUI，实现RESTful API文档的自动生成与测试。包括pom文件配置、配置文件编写、接口注解使用等步骤。

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

1.SwaggerUI的简单介绍

Swagger是一个Restful风格接口的文档在线自动生成和测试的框架
官网：http://swagger.io
官方描述：The World’s Most Popular Framework for APIs.
页面UI如下：

demo内的接口，已在之前的文章中介绍过，有兴趣的同学可以自己看一看：
SpringBoot框架使用（返回cookies信息的get接口开发）
SpringBoot框架使用（携带cookies信息访问的get接口开发）
SpringBoot框架使用（两种携带参数的get接口开发）

2.pom文件配置

在pom.xml文件中，引入swagger的包

    <properties>
        <swagger.version>2.6.1</swagger.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
    </dependencies>

3.新建配置文件

在main/java目录下，新建com.course.config目录以存放配置文件，然后新建SwaggerConfig。

配置内容如下：

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select()
                .paths(PathSelectors.regex("/.*"))
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("我的接口文档")
                .contact(new Contact("Lyn","","326030434@qq.com"))
                .description("这是SwaggerUi生成的接口文档")
                .build();

    }
}

4.给接口加上注解

首先要在整个类前面加上

@Api(value = "/",description = "这是所有get方法")

然后在每个接口前加上

@ApiOperation(value = "通过这个方法可以获取到cookies",httpMethod = "GET")

在这里，以/getcookies接口举例，完整代码如下

@RestController
@Api(value = "/",description = "这是所有get方法")
public class MyGetMethod {

    @RequestMapping(value = "/getcookies",method = RequestMethod.GET)
    @ApiOperation(value = "通过这个方法可以获取到cookies",httpMethod = "GET")
    public String getCookies(HttpServletResponse response){
        //HttpServletRequest  装请求信息的类
        //HttpServletResponse  装相应信息的类
        Cookie cookie = new Cookie("login","true");
        response.addCookie(cookie);
        return "恭喜获得cookies信息成功";
    }
}

5.修改Application文件

之前是@ComponentScan(“com.course.server”)并没有包含到com.course.config文件，所以，这里修改为@ComponentScan(“com.course”)

@SpringBootApplication
@ComponentScan("com.course")
public class Application {
    public static void main(String[] args){
        SpringApplication.run(Application.class,args);
    }
}