swagger 配置类 存档

备份一下swagger配置类， 后面要用的时候直接用。

导入坐标：

        <!-- 集成swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>

在Config下新建一个swagger配置类。

package com.techen.ami.config;
import java.util.ArrayList;
import java.util.List;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2配置
 * 访问地址：http://ip:port/swagger-ui.html
 * 访问地址（增强）：http://ip:port/doc.html
 * @author tom
 * @date 2019年11月12日
 * @Modify
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
    	// 增加header
    	// 在所有rest统一添加一个参数
    	ParameterBuilder parameterBuilder = new ParameterBuilder();
    	List<Parameter> params = new ArrayList<Parameter>();
    	parameterBuilder.name("Authorization").description("token")
    			.modelRef(new ModelRef("string"))
    			.parameterType("header")
    			.defaultValue("Bearer ")
    			.required(true)
    			.build();
    	params.add(parameterBuilder.build());
    	// 配置规则
    	return new Docket(DocumentationType.SWAGGER_2)
    			.apiInfo(apiInfo())
    			.select()
    			.apis(RequestHandlerSelectors.basePackage("要管理的包路径"))
    			.paths(PathSelectors.any())
    			.build()
    			.globalOperationParameters(params);
    }
    
    private ApiInfo apiInfo(){
    	Contact contact = new Contact("用户姓名", "http://www.XXXXX.cn", "用户邮箱");
    	return new ApiInfoBuilder()
				.title("springboot integrate swagger2")
				.description("springboot integrate swagger2")
				.termsOfServiceUrl("")
				.contact(contact)
				.version("1.0")
				.build();
    }

}

swagger详细注解说明参考：https://blog.csdn.net/xiaojin21cen/article/details/78654652

 

swagger微服务下，多个服务统一管理接口参考：https://blog.csdn.net/qq_31748587/article/details/102563155