【PIG】pig4cloud整合 knife4j

 注意：此教程基于pig的3.4.6版本，其他版本没有尝试，理论上只要用的是swagger都适用，如果是spring-doc就不适用了。

第一步，修改pig-common-swagger模块的pom.xml，删除springfox相关依赖，增加一条knife4j依赖

修改前：

<!--接口文档-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>${swagger.fox.version}</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>${swagger.fox.version}</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-oas</artifactId>
			<version>${swagger.fox.version}</version>
		</dependency>

修改后：

<!--接口文档-->
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-spring-boot-starter</artifactId>
			<version>2.0.9</version>
		</dependency>

PS：为什么用2.0.9而不是3.0.3，因为3.0.3bug比较多，2.0.9够用了

第二步，修改 GatewaySwaggerAutoConfiguration类，增加@Primary注解

修改前：

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
public class GatewaySwaggerAutoConfiguration {

	@Bean
	public SwaggerProvider swaggerProvider(SwaggerProperties swaggerProperties, GatewayProperties gatewayProperties) {
		return new SwaggerProvider(swaggerProperties, gatewayProperties);
	}

	@Bean
	public SwaggerResourceHandler swaggerResourceHandler(SwaggerProvider swaggerProvider) {
		return new SwaggerResourceHandler(swaggerProvider);
	}

修改后：

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
public class GatewaySwaggerAutoConfiguration {

	@Primary
	@Bean
	public SwaggerProvider swaggerProvider(SwaggerProperties swaggerProperties, GatewayProperties gatewayProperties) {
		return new SwaggerProvider(swaggerProperties, gatewayProperties);
	}

	@Bean
	public SwaggerResourceHandler swaggerResourceHandler(SwaggerProvider swaggerProvider) {
		return new SwaggerResourceHandler(swaggerProvider);
	}

不加Primary注解会报错：

***************************
APPLICATION FAILED TO START
***************************

Description:

Parameter 0 of constructor in springfox.documentation.swagger.web.ApiResourceController required a single bean, but 2 were found:
	- inMemorySwaggerResourcesProvider: defined in URL [jar:file:/C:/Users/Administrator/.m2/repository/io/springfox/springfox-swagger-common/3.0.0/springfox-swagger-common-3.0.0.jar!/springfox/documentation/swagger/web/InMemorySwaggerResourcesProvider.class]
	- swaggerProvider: defined by method 'swaggerProvider' in com.tmzh.mediacube.common.swagger.config.GatewaySwaggerAutoConfiguration


Action:

Consider marking one of the beans as @Primary, updating the consumer to accept multiple beans, or using @Qualifier to identify the bean that should be consumed

第三步，修改 WebFluxSwaggerConfiguration 类

修改前：

@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/swagger-ui/**")
				.addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
				.resourceChain(false);
	}

修改后：

@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/swagger-ui/**")
				.addResourceLocations("classpath:/META-INF/resources/webjars/")
				.resourceChain(false);
	}

第四步，修改 SwaggerAutoConfiguration 类，处理一下报错的部分，主要是把@EnableSwagger2改成@EnableSwagger2WebMvc，再把版本请求头处理的相关代码删除即可。

另外，如果要使用knife4j增强功能，需要给GatewaySwaggerAutoConfiguration增加@ComponentScan("springfox.documentation.schema")，否则gateway启动会失败。