SpringBoot集成SwaggerUI

偏执的太偏执、 2022-05-23 02:51 218阅读 0赞

#### 1.SwaggerUI的简单介绍 ####

Swagger是一个Restful风格接口的文档在线自动生成和测试的框架  
官网：[http://swagger.io][http_swagger.io]  
官方描述：The World’s Most Popular Framework for APIs.  
页面UI如下：  
![70][]  
demo内的接口，已在之前的文章中介绍过，有兴趣的同学可以自己看一看：  
[SpringBoot框架使用（返回cookies信息的get接口开发）][SpringBoot_cookies_get]  
[SpringBoot框架使用（携带cookies信息访问的get接口开发）][SpringBoot_cookies_get 1]  
[SpringBoot框架使用（两种携带参数的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。  
![70 1][]  
配置内容如下：

@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);
        }
    }

#### 6.查看接口文档 ####

Rerun Application文件，然后浏览器访问[http://localhost:9527/swagger-ui.html][http_localhost_9527_swagger-ui.html]  
![70 2][]  
到这里SwaggerUI的集成就完成了！

[http_swagger.io]: http://swagger.io
[70]: /images/20220523/ee1a801954274bbdb6016e972f255dcc.png
[SpringBoot_cookies_get]: https://blog.csdn.net/lt326030434/article/details/80496523
[SpringBoot_cookies_get 1]: https://blog.csdn.net/lt326030434/article/details/80499742
[SpringBoot_get]: https://blog.csdn.net/lt326030434/article/details/80523283
[70 1]: /images/20220523/2eb45befe6af4322a90c4e1479dd89ef.png
[http_localhost_9527_swagger-ui.html]: http://localhost:9527/swagger-ui.html
[70 2]: /images/20220523/75e408e082a24c329293d094cb51c68d.png