SpringCloud集成Swagger2

小咪咪 2022-01-21 08:27 649阅读 0赞

### 文章目录 ###

*  编写背景
 *  源码

# 编写背景 #

由于在之前的文章中，我们已经介绍了在传统的SSM项目中如何集成Swagger（详情请查看[在SpringMVC中集成Swagger2][SpringMVC_Swagger2]），但是由于现在的项目架构采用的是SpringCloud微服务架构，虽然说在此时的架构中，后端的难度被大大的解放，引入Swagger2配置也变得更加的简单，不过既然快乐编程的一大原则就是复制粘贴，因而我觉得有必要将其再写出来，尽管说它非常的简单

# 源码 #

**引入依赖：**

在这里，我们选用的`swagger.version`的版本号为`2.9.2`。

<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>

**Java源码：**

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    /** * Swagger2配置类 * @Configuration：让Spring来加载该类配置。 * @EnableSwagger2：启用Swagger2。 */
    @EnableSwagger2
    @Configuration
    public class Swagger2{ 
    
        /** * 创建API应用 * apiInfo() 增加API相关信息 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现， * 本例采用指定扫描的包路径来定义指定要建立API的目录。 * @return */
        @Bean
        public Docket createRestApi() { 
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.**.account.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        /** * 创建该API的基本信息（这些基本信息会展现在文档页面中） * 访问地址：http://项目实际地址/swagger-ui.html * @return */
        private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    .title("SpringMVC 中使用Swagger2构建RESTful APIs")
                    .description("**账号后台登录操作系统")
                    .termsOfServiceUrl("http://www.**.com")
                    .license("证书")
                    .licenseUrl("证书地址")
                    .version("1.0")
                    .build();
        }
    
    }

在经过了上述简单配置与编码后，我们直接就可以在自己的项目中使用了。

[SpringMVC_Swagger2]: https://blog.csdn.net/ZZY1078689276/article/details/80290847