SpringBoot服務添加Swagger接口文檔全過程

導入依賴:版本隨便你選

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

添加核心配置：com.tianfu.system.agent.controller這個掃的是你的controller路徑

package com.tianfu.system.agent.Config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
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.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * Swagger配置類
 */
@SuppressWarnings("all")
@EnableSwagger2
@Configuration
public class SwaggerConfig extends WebMvcConfigurationSupport {
	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
		registry.addResourceHandler("swagger-ui.html")
			.addResourceLocations("classpath:/META-INF/resources/");
		registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
		//registry.addResourceHandler("/webjars/**")
		registry.addResourceHandler("/webjars")
			.addResourceLocations("classpath:/META-INF/resources/webjars/");
		super.addResourceHandlers(registry);
	}
	@Override
	public void addCorsMappings(CorsRegistry registry) {
		registry.addMapping("/**")
			.allowedOrigins("*")
			.allowedMethods("get", "post", "put", "options", "delete", "patch")
			.allowCredentials(true).maxAge(3600);
	}
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
			.groupName("")
			.apiInfo(apiInfo())
			.select()
			.apis(RequestHandlerSelectors.basePackage("com.tianfu.system.agent.controller"))
			.paths(PathSelectors.any())
			.build();
			//添加請求頭
			//.globalOperationParameters(setHeaderTocken());
	}

//	private List<Parameter> setHeaderTocken() {
//		ParameterBuilder tokenPar = new ParameterBuilder();
//		List<Parameter> pars = new ArrayList<>();
//		tokenPar.name("Blade-Auth").description("Tocken請求頭").modelRef(new ModelRef("String")).parameterType("header").required(false).build();
//		pars.add(tokenPar.build());
//		return pars;
//	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
			.title("TFCloud雲平臺接口文檔")//標題
			.description("")//描述
			.version("1.0")//版本號
			.build();
	}
}

啓動類添加註解:

@EnableSwagger2
//這個是掃全部工程下的類  主包
@ComponentScan("com.tianfu")

訪問路徑;http://ip:端口/swagger-ui.html即可