自己写一个新工程整合 knife4j、 gateway、nacos 报错。因此过来请教一下，欢迎批评指正。

目前报错的是网页，访问 http://localhost:10051/doc.html 时前端控制台输出异常如图，麻烦指正一下，谢谢~~
![输入图片说明](https://images.gitee.com/uploads/images/2022/0217/001658_e3e04189_8255718.png "屏幕截图.png")

--------------------------------------------------------------------------------

![输入图片说明](https://images.gitee.com/uploads/images/2022/0217/001848_f33a4191_8255718.png "屏幕截图.png")

--------------------------------------------------------------------------------

**parent.pom**

```
        <properties>
		<java.version>1.8</java.version>
		<spring.cloud.alibaba.version>2.2.6.RELEASE</spring.cloud.alibaba.version>
		<spring.cloud.security.version>2.2.5.RELEASE</spring.cloud.security.version>
		<spring.cloud.version>Hoxton.SR8</spring.cloud.version>
		<knife4j.version>2.0.8</knife4j.version>
		<nimbus.jose.jwt.version>9.1.1</nimbus.jose.jwt.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
			<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
			<version>${spring.cloud.alibaba.version}</version>
		</dependency>
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
			<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
			<version>${spring.cloud.alibaba.version}</version>
		</dependency>

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-redis-reactive</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-redis</artifactId>
		</dependency>
		
		<dependency>
			<groupId>org.apache.commons</groupId>
			<artifactId>commons-pool2</artifactId>
		</dependency>

<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
		</dependency>

<dependency>
			<groupId>cn.hutool</groupId>
			<artifactId>hutool-all</artifactId>
			<version>5.5.9</version>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.75</version>
		</dependency>

<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-micro-spring-boot-starter</artifactId>
			<version>${knife4j.version}</version>
			<scope>compile</scope>
		</dependency>
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-spring-boot-starter</artifactId>
			<version>${knife4j.version}</version>
			<scope>compile</scope>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>3.0.0</version>
		</dependency>

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-jdbc</artifactId>
		</dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>

</dependencies>
	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring.cloud.version}</version>
			</dependency>
			<dependency>
				<groupId>com.alibaba.cloud</groupId>
				<artifactId>spring-cloud-alibaba-dependencies</artifactId>
				<version>${spring.cloud.alibaba.version}</version>
			</dependency>

<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-starter-security</artifactId>
				<version>${spring.cloud.security.version}</version>
			</dependency>
			<dependency>
				<groupId>com.nimbusds</groupId>
				<artifactId>nimbus-jose-jwt</artifactId>
				<version>${nimbus.jose.jwt.version}</version>
			</dependency>

<dependency>
				<groupId>com.alibaba</groupId>
				<artifactId>druid-spring-boot-starter</artifactId>
				<version>1.2.5</version>
			</dependency>
			
		</dependencies>
	</dependencyManagement>
```

--------------------------------------------------------------------------------
 **gateway.pom**

```
	<dependencies>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-gateway</artifactId>
			<version>${spring.cloud.alibaba.version}</version>
		</dependency>
	</dependencies>
```

--------------------------------------------------------------------------------

```
spring:

cloud:
        gateway:
            discovery:
                locator:
                    enabled: true
#            routes:
#                # 权限
#                -   id: lcy-security
#                    uri: lb://lcy-security
#                    predicates:
#                        - Path=/security/**
#                    filters:
#                        - StripPrefix=1
        nacos:
            config:
                server-addr: 127.0.0.1:8848/
                group: DEFAULT_GROUP
                file-extension: yml
            discovery:
                server-addr: 127.0.0.1:8848/
    application:
        name: lcy-gateway
    datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/ycl_base?serverTimezone=Asia/Shanghai&useSSL=false&useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true
        username: root
        password: '0000'
        druid:
            initial-size: 5
            min-idle: 10
            max-active: 30
            max-wait: 60000
    redis:
        host: localhost
        port: 6379
        timeout: 10000
        lettuce:
            pool:
                max-idle: 8
                min-idle: 0
                max-wait: -1
                max-active: 50
server:
    port: 10051

exclude:
    url:
        - /security/check
        - /security/login
#knife4j:
#    cloud:
#        enable: true # 增加模式, 不开无法进行接口排序
#        routes:
#            -   name: 测试分组1
#                uri: knife4j.xiaominfo.com
#                location: /v2/api-docs?group=2.X版本
#            -   name: 测试分组2
#                uri: knife4j.xiaominfo.com
#                location: /v2/api-docs?group=3.默认接口
```
--------------------------------------------------------------------------------

**工程内部java代码**

```
@Configuration
@EnableSwagger2
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {

//@Bean(value = "lcy-security")
	//@Order(value = 1)
	public Docket groupRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(groupApiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("lcy.security.controller"))
				.paths(PathSelectors.any())
				.build();
	}

private ApiInfo groupApiInfo(){
		return new ApiInfoBuilder()
				.title("SpringCloud")
				.description("<div style='font-size:14px;color:red;'>SpringCloud</div>")
				.version("1.0")
				.build();
	}
}
```

--------------------------------------------------------------------------------

```
@Slf4j
@Component
public class AuthGlobalFilter implements GlobalFilter, Ordered {
	@Resource
	private ExcludeUrlProperties excludeUrlProperties;

private final AntPathMatcher antPathMatcher = new AntPathMatcher();

@Resource
	private StringRedisTemplate stringRedisTemplate;

@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
		log.info("=======请求拦截=====" + JSONObject.toJSONString(antPathMatcher));
		if (antPathMatcher.match("/**/v2/api-docs/**", exchange.getRequest().getPath().value())) {
			return chain.filter(exchange);
		}
		return chain.filter(exchange);
	}

@SuppressWarnings("all")
	private boolean hasPermission(String headerToken, String path) {
		if (StrUtil.isEmpty(headerToken)) {
			return false;
		}
		return true;
	}

@Override
	public int getOrder() {
		return 0;
	}
}

```
--------------------------------------------------------------------------------
 
```
@RestController
@RequestMapping("/swagger-resources")
public class SwaggerController {

@Autowired(required = false)
	private SecurityConfiguration securityConfiguration;
	@Autowired(required = false)
	private UiConfiguration uiConfiguration;
	private final SwaggerResourcesProvider swaggerResources;

@Autowired
	public SwaggerController(SwaggerResourcesProvider swaggerResources) {
		this.swaggerResources = swaggerResources;
	}

@GetMapping("/configuration/security")
	public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
		return Mono.just(new ResponseEntity<>(
				Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
	}

@GetMapping("/configuration/ui")
	public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
		return Mono.just(new ResponseEntity<>(
				Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
	}

@GetMapping("")
	public Mono<ResponseEntity> swaggerResources() {
		return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
	}
}
``` 
--------------------------------------------------------------------------------

```
@Slf4j
@Component
@Primary
@AllArgsConstructor
public class SwaggerProvider2 implements SwaggerResourcesProvider {

public static final String API_URI = "/v2/api-docs";
	private final RouteLocator routeLocator;
	private final GatewayProperties gatewayProperties;

@Override
	public List<SwaggerResource> get() {
		List<SwaggerResource> resources = new ArrayList<>();
		List<String> routes = new ArrayList<>();
		routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
		gatewayProperties.getRoutes().stream().filter(routeDefinition -> routes.contains(routeDefinition.getId()))
				.forEach(routeDefinition -> routeDefinition.getPredicates().stream()
						.filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
						.forEach(predicateDefinition -> {
							//String location = predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0");
							//location = location.replace("/**", API_URI);
							//resources.add(swaggerResource(routeDefinition.getId(), API_URI));

resources.add(swaggerResource(routeDefinition.getId(),
									predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0")
											.replace("/**", API_URI)));
						}));
		return resources;
	}

private SwaggerResource swaggerResource(String name, String location) {
		log.info("{}, {}", name, location);
		SwaggerResource swaggerResource = new SwaggerResource();
		swaggerResource.setName(name);
		swaggerResource.setLocation(location);
		swaggerResource.setSwaggerVersion("2.0");
		return swaggerResource;
	}
}
```
--------------------------------------------------------------------------------

首先考虑的是gateway不支持tomcat容器, 但swagger又是基于tomcat, 所以如果直接将SwaggerConfig配置在gateway里就会有错.

第二, 大部分是工程版本的问题, 目前我的配置如下:
		<spring.boot.version>2.2.5.RELEASE</spring.boot.version>
		<spring.cloud.version>Hoxton.SR8</spring.cloud.version>
		<spring.cloud.alibaba.version>2.2.1.RELEASE</spring.cloud.alibaba.version>
		<knife4j.version>2.0.8</knife4j.version>

第三, 我在gateway里配置的swagger页面显示, 我一共配置了2个(SwaggerProvider, SwaggerHandler)
配置如下
--------------------------------SwaggerHandler    START--------------------------------
package ycl.gateway.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;
import springfox.documentation.swagger.web.*;

import java.util.Optional;

/**
 * swagger配置
 *
 * @author ycl
 * @date 2022/6/21 0021 18:09:00
 */
@RestController
public class SwaggerHandler {

@Autowired(required = false)
	private SecurityConfiguration securityConfiguration;

@Autowired(required = false)
	private UiConfiguration uiConfiguration;

private final SwaggerResourcesProvider swaggerResources;

@Autowired
	public SwaggerHandler(SwaggerResourcesProvider swaggerResources) {
		this.swaggerResources = swaggerResources;
	}

/**
	 * Swagger安全配置，支持oauth和apiKey设置
	 */
	@GetMapping("/swagger-resources/configuration/security")
	public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
		return Mono.just(new ResponseEntity<>(
				Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
	}

/**
	 * Swagger UI配置
	 */
	@GetMapping("/swagger-resources/configuration/ui")
	public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
		return Mono.just(new ResponseEntity<>(
				Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
	}

/**
	 * Swagger资源配置，微服务中这各个服务的api-docs信息
	 */
	@GetMapping("/swagger-resources")
	public Mono<ResponseEntity> swaggerResources() {
		return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
	}
}

--------------------------------SwaggerHandler    END--------------------------------
--------------------------------SwaggerProvider    START--------------------------------
package ycl.gateway.config;

import lombok.AllArgsConstructor;
import org.springframework.cloud.gateway.config.GatewayProperties;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.support.NameUtils;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;

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

/**
 * swagger配置
 *
 * @author ycl
 * @date 2022/6/21 0021 18:09:00
 */
@Component
@Primary
@AllArgsConstructor
public class SwaggerProvider implements SwaggerResourcesProvider {
	public static final String API_URI = "v2/api-docs";
	private final RouteLocator routeLocator;
	private final GatewayProperties gatewayProperties;

@Override
	public List<SwaggerResource> get() {
		List<SwaggerResource> resources = new ArrayList<>();
		List<String> routes = new ArrayList<>();
		routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
		gatewayProperties.getRoutes().stream().filter(routeDefinition -> routes.contains(routeDefinition.getId()))
				.forEach(routeDefinition -> routeDefinition.getPredicates().stream()
						.filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
						.forEach(predicateDefinition -> resources.add(swaggerResource(routeDefinition.getId(),
								predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0")
										.replace("**", API_URI)))));
		return resources;
	}

private SwaggerResource swaggerResource(String name, String location) {
		SwaggerResource swaggerResource = new SwaggerResource();
		swaggerResource.setName(name);
		swaggerResource.setLocation(location);
		swaggerResource.setSwaggerVersion("2.0");
		return swaggerResource;
	}
}
--------------------------------SwaggerProvider    END--------------------------------

第四到了页面显示配置, 也就是开头的SwaggerConfig. 我的配置是这样的, 加了个token请求头. 这个文件放在common里. 注意这里是抽象类

--------------------------------BaseSwaggerConfig    START--------------------------------
package ycl.common.config;

import com.google.common.collect.Lists;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
import ycl.common.constants.SecurityConstant;

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

/**
 * @author: YCL
 * @date: 2022/03/04 15:22:43
 */
@Configuration
@EnableSwagger2WebMvc
public abstract class BaseSwaggerConfig {

//配置swagger的Docket的bean实例
	@Bean
	public Docket docket() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				//注意basePackage改成自己每个项目的路径
				.apis(RequestHandlerSelectors.any())
				.paths(PathSelectors.any())
				.build()
				.securitySchemes(securitySchemes())
				.securityContexts(securityContexts());
	}

private List<SecurityContext> securityContexts() {
		ArrayList<SecurityContext> list = Lists.newArrayList();
		SecurityContext build = SecurityContext.builder()
				.securityReferences(securityReferences())
				.build();
		list.add(build);
		return list;
	}

/**
	 * 全局认证
	 *
	 * @return 认证列表
	 */
	private List<SecurityReference> securityReferences() {
		AuthorizationScope scope = new AuthorizationScope("global", "accessEverything");
		AuthorizationScope[] scopes = new AuthorizationScope[1];
		scopes[0] = scope;
		ArrayList<SecurityReference> list = Lists.newArrayList();
		list.add(new SecurityReference(SecurityConstant.TOKEN, scopes));
		return list;
	}

/**
	 * 默认请求头token
	 *
	 * @return 认证列表
	 */
	private List<SecurityScheme> securitySchemes() {
		ArrayList<SecurityScheme> list = Lists.newArrayList();
		list.add(new ApiKey(SecurityConstant.TOKEN, SecurityConstant.TOKEN, "header"));
		return list;
	}

//配置swagger信息
	private ApiInfo apiInfo() {
		Contact contact = new Contact("YCL", "不告诉你", "28*******6@qq.com");
		return new ApiInfo("spring cloud 文档",
				"YCL spring cloud",
				"1.0",
				"不告诉你",
				contact,
				"Apache 2.0",
				"http://www.apache.org/licenses/LICENSE-2.0",
				new ArrayList<>()
		);
	}
}

--------------------------------BaseSwaggerConfig    END--------------------------------

在每个服务模块, 加上一个swagger配置类, 如果没有这个配置类项目依旧可以启动成功, 但请求头可能不显示

--------------------------------SwaggerConfig    START--------------------------------

package ycl.schedule.config;

import org.springframework.context.annotation.Configuration;
import ycl.common.config.BaseSwaggerConfig;

/**
 * swagger配置
 *
 * @author ycl
 * @date 2022/6/23 0023 22:51:33
 */
@Configuration
public class SwaggerConfig extends BaseSwaggerConfig {
}

--------------------------------SwaggerConfig    END--------------------------------

最后, gateway配置文件, bootstrap.yml里要加上所有的服务模块的路由地址, 否则分组显示不出来
要注意的是, 目前我的工程所有的路由都需要手动配置才显示在分组里, 如果此服务没有启动, 访问会说knife4j异常

--------------------------------bootstrap.yml    START--------------------------------

spring:
    application:
        name: ycl-gateway
    cloud:
        gateway:
            discovery:
                locator:
                    # 开启后 route 会失效
                    enabled: false
                    lower-case-service-id: true
            routes:
                #没有启动项目时会报错, 目前需要手动加
                # 权限模块
                -   id: ycl-service1
                    uri: lb://ycl-service1
                    predicates:
                        - Path=/ycl-service1/**
                    filters:
                        - StripPrefix=1
                -   id: ycl-service2
                    uri: lb://ycl-service2
                    predicates:
                        - Path=/ycl-service2/**
                    filters:
                        - StripPrefix=1

--------------------------------bootstrap.yml    END--------------------------------

萧明/swagger-bootstrap-ui-demo

内容风险标识

评论 (4)

萧明/swagger-bootstrap-ui-demo .gitee-modal { width: 500px !important; }

内容风险标识