SpringBoot如何与Swagger集成？

痛定思痛。 2022-04-02 11:18 305阅读 0赞

集成一个新东西的套路：引jar包，改配置，贼爽贼爽地使用。  
Swagger这个东西对我来说不是个陌生的东西了，使用Swagger确实给研发带来极大的便利。  
个人认为它就是个API接口文档。  
**以前：**  
后端开发先写出接口文档，有的用word写，有的用Markdown编辑，个人感觉有些麻烦。  
**现在：**  
有了swagger，后端可以先定义好接口，业务逻辑暂时不用写，界面便可展示出来供前端开发。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvbmd3ZWkxNTczMjYyMzM2NA_size_16_color_FFFFFF_t_70]  
当然利用swagger的注解可以让接口注释更清晰，我们先来谈谈如何集成：

# 引jar #

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

# 配置 #

/**
     * swagger 配置访问地址：http://localhost:8281/swagger-ui.html
     */
    @Configuration
    @EnableSwagger2
    public class Swagger2Config {
    
        @Bean
        public Docket docket() {
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .paths(PathSelectors.any()).build();
        }
    
        //构建api文档的详细信息函数
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    //页面标题
                    .title("微信基础服务")
                    //版本号
                    .version("1.0")
                    //描述
                    .description("API 描述")
                    .build();
        }
    
    }

# swagger的使用 #

有关注解使用：  
请参考：[https://segmentfault.com/a/1190000015671612][https_segmentfault.com_a_1190000015671612]

**注意：**  
生产环境我们要关闭swagger接口的展示，只需要在application配置文件添加swagger.show来控制接口暴露的开关：  
swagger.show=true 或者swagger.show=false来控制接口是否展示

**总结：**  
掌握这些，开发没问题，有关swagger的强大功能还有待挖掘，好用的东西多分享。

感谢您的阅读！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvbmd3ZWkxNTczMjYyMzM2NA_size_16_color_FFFFFF_t_70]: /images/20220402/a96c8de14078477692ce8fcb25a59a9a.png
[https_segmentfault.com_a_1190000015671612]: https://segmentfault.com/a/1190000015671612