knife4j3.0.3整合gateway和注册中心的详细过程

 1.82.3.12.RELEASEHoxton.SR122.2.10-RC13.0.3   org.springframework.bootspring-boot-dependencies${spring-boot.version}pomimport org.springframework.cloudspring-cloud-dependencies${spring-cloud.version}pomimport com.alibaba.cloudspring-cloud-alibaba-dependencies${spring-cloud-alibaba.version}pomimport com.github.xiaoyminknife4j-dependencies${knife4j.version}pomimport

 org.springframework.cloudspring-cloud-starter-gateway com.alibaba.cloudspring-cloud-starter-alibaba-nacos-discovery com.github.xiaoyminknife4j-spring-boot-starter

server: port: 8888 spring: main: web-application-type: reactive application: name: gateway

spring: cloud: nacos: server-addr: localhost:8848 username: nacos password: nacos discovery: enabled: true namespace: 776074db-06ad-4991-bb68-99b41ae971c9 gateway: routes: - id: news uri: lb://news predicates: - Path=/news/** filters: - StripPrefix=1

import lombok.RequiredArgsConstructor; 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.SwaggerResource; import springfox.documentation.swagger.web.SwaggerResourcesProvider; import java.util.List; /** * @author √Angelの爱灬 * @date 2023/3/23 */ @RestController @RequiredArgsConstructor public class SwaggerController { private final SwaggerResourcesProvider swaggerResources; @GetMapping("/swagger-resources") public Mono>> swaggerResources() { return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK))); } }

import com.msf.gateway.enums.ServiceEnum; import lombok.RequiredArgsConstructor; import org.springframework.cloud.gateway.config.GatewayProperties; import org.springframework.cloud.gateway.route.RouteDefinition; 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; /** * 获取网关路由判断哪些路由需要使用文档 * * @author √Angelの爱灬 * @date 2023/3/23 */ @Primary @Component @RequiredArgsConstructor public class SwaggerResourceConfig implements SwaggerResourcesProvider { private final String API_URI = "v2/api-docs"; private final GatewayProperties gatewayProperties; @Override public List get() { // 接口资源列表 List resources = new ArrayList<>(); // resources为所有路由都加载到文档，如果需要部分显示，在下方使用filter进行过滤即可 for (RouteDefinition route : gatewayProperties.getRoutes()) { route.getPredicates().stream() .filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName())) .forEach(predicateDefinition -> resources.add(swaggerResource(ServiceEnum.getServiceName(route.getId()), predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("**", API_URI)))); } return resources; } private SwaggerResource swaggerResource(String name, String url) { SwaggerResource swaggerResource = new SwaggerResource(); swaggerResource.setName(name); swaggerResource.setLocation(url); swaggerResource.setUrl(url); swaggerResource.setSwaggerVersion("2.0"); return swaggerResource; } } 

import lombok.AllArgsConstructor; /** * 服务列表 * * @author √Angelの爱灬 * @date 2023/3/23 */ @AllArgsConstructor public enum ServiceEnum { //新闻模块 news("新闻模块"); private final String serviceName; public static String getServiceName(String name) { for (ServiceEnum service : ServiceEnum.values()) { if (name.equals(service.name())) { return service.serviceName; } } return "服务路由字典错误！"; } }

 org.springframework.bootspring-boot-starter-web com.alibaba.cloudspring-cloud-starter-alibaba-nacos-discovery com.github.xiaoyminknife4j-micro-spring-boot-starter  javax.validationvalidation-api

server: port: 8080 spring: application: name: news

spring: cloud: nacos: server-addr: localhost:8848 username: nacos password: nacos discovery: enabled: true namespace: 776074db-06ad-4991-bb68-99b41ae971c9 knife4j: enable: true

import com.msf.common.constant.Constant; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.HttpMethod; import springfox.documentation.builders.*; import springfox.documentation.service.*; 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配置 * * @author √Angelの爱灬 * @date 2023/3/21 */ @Slf4j @Configuration @EnableSwagger2 public class SwaggerConfig { @Value("${spring.profiles.active:}") private String active; @Bean public Docket docDocket() { boolean enableSwagger = !Constant.SPRING_PROFILES_ACTIVE_PRO.equalsIgnoreCase(active); return new Docket(DocumentationType.SWAGGER_2) // 非生产环境启用 .enable(enableSwagger) .apiInfo(apiInfo()) .globalResponses(HttpMethod.GET, globalResponse()) .globalResponses(HttpMethod.POST, globalResponse()) .globalResponses(HttpMethod.PUT, globalResponse()) .globalResponses(HttpMethod.DELETE, globalResponse()) .select() .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) .paths(PathSelectors.any()) .build() .globalRequestParameters(globalRequestParameters()); } private ApiInfo apiInfo() { String title = "新闻模块"; String description = "
新闻模块knife4j接口文档
"; String version = "1.0.0"; String termsOfServiceUrl = ""; Contact contact = new Contact("√Angelの爱灬", "", ""); return new ApiInfoBuilder() .title(title) .description(description) .version(version) .termsOfServiceUrl(termsOfServiceUrl) .contact(contact) .build(); } private List globalResponse(){ List responseList = new ArrayList<>(); responseList.add(new ResponseBuilder().code("401").description("未认证").build()); responseList.add(new ResponseBuilder().code("403").description("请求被禁止").build()); responseList.add(new ResponseBuilder().code("404").description("找不到资源").build()); return responseList; } private List globalRequestParameters() { List parameters = new ArrayList<>(); RequestParameterBuilder requestParameterBuilder = new RequestParameterBuilder(); RequestParameter username = requestParameterBuilder .name("username").description("用户账号").in(ParameterType.HEADER) .build(); RequestParameter token = requestParameterBuilder .name("token").description("token").in(ParameterType.HEADER) .build(); parameters.add(username); parameters.add(token); return parameters; } }