Swagger集成

注意： 因为Swagger需要对代码打注解，所以具有代码侵入性，建议尽量不要使用Swagger！

1. 增加 ape-common-swagger 模块

2.引入相关依赖：

ape-common-swagger的pom.xml文件：

<dependencies>
    <!-- 引入Swagger依赖 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.7.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.7.0</version>
    </dependency>

    <!--仅使用springboot的注解功能 引入该注解-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <version>2.4.2</version>
    </dependency>
</dependencies>

3. 配置Swagger自动装配

3.1 创建 SwaggerBean 类

说明： 这个 SwaggerBean 类的作用在于读取配置文件中以swagger开头的配置项！

注意： 这里为了减少框架依赖，就没有引入Lombok了！

package com.ssm.swagger.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "swagger")
//工具模块仅使用springboot注解,要引入spring-boot-autoconfigure
//为了不引入lombok太冗余，我们手动实现set get方法
public class SwaggerBean {
    private String basePackage;

    private String title;

    private String contactName;

    private String contactUrl;

    private String contactEmail;

    private String version;

    private String description;

    public String getBasePackage() {
        return basePackage;
    }

    public void setBasePackage(String basePackage) {
        this.basePackage = basePackage;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getContactName() {
        return contactName;
    }

    public void setContactName(String contactName) {
        this.contactName = contactName;
    }

    public String getContactUrl() {
        return contactUrl;
    }

    public void setContactUrl(String contactUrl) {
        this.contactUrl = contactUrl;
    }

    public String getContactEmail() {
        return contactEmail;
    }

    public void setContactEmail(String contactEmail) {
        this.contactEmail = contactEmail;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

3.2 创建SwaggerConfig类

说明： 在ape-common-swagger下创建SwaggerConfig类进行自动装配！

package com.ssm.swagger.config;

import com.ssm.swagger.bean.SwaggerBean;
import org.springframework.beans.factory.annotation.Autowired;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2 //开启swagger注解
//因为Swagger需要对代码打注解，所以具有代码侵入性，建议尽量不要使用Swagger！
public class SwaggerConfig {

    @Autowired
    private SwaggerBean swaggerBean;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2) //类型为swagger2
                .apiInfo(this.getApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(swaggerBean.getBasePackage()))
                .paths(PathSelectors.any())
                .build();
    }

    public ApiInfo getApiInfo() {
        return new ApiInfoBuilder()
                .title(swaggerBean.getTitle())
                .contact(new Contact(swaggerBean.getContactName(), swaggerBean.getContactUrl(), swaggerBean.getContactEmail()))
                .version(swaggerBean.getVersion())
                .description(swaggerBean.getDescription())
                .build();
    }
}

3.3 在业务模块配置文件中配置相应参数

说明： 虽然我们字段是 basePackage，但是在配置文件中可以用 驼峰basePackage方式 和 非驼峰base-package方式 两种！

swagger: #访问地址 http://localhost:8080/swagger-ui.html
  basePackage: com.ssm #也可写成非驼峰方式base-Package
  title: ape-user
  contactName: 经典鸡翅
  contactUrl: https://gitee.com/ssm111/ape-frame.git
  contactEmail: 3513582592@qq.com
  version: 1.0版本
  description: 开箱即用的脚手架