springGateway聚合各服务Swagger进行统一管理

最新推荐文章于 2024-06-06 17:38:26 发布

it界的哈士奇

最新推荐文章于 2024-06-06 17:38:26 发布

阅读量1.1k

点赞数 1

文章标签： gateway java swagger

本文链接：https://blog.youkuaiyun.com/m0_47333020/article/details/120880623

版权

网关配置

引入swagger相关依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

这里不建议引入像swagger-bootstrap-ui的第三方ui，对swagger3注解的兼容性不大好（我试了）

添加SwaggerConfig

@Component
@Primary
public class SwaggerConfig implements SwaggerResourcesProvider {

    /**
     * swagger3默认的url后缀
     */
    private static final String SWAGGER2URL = "/v3/api-docs"; //要使用ui的话 改成v2 不然会出bug  比如有的地方 没有输入框

    /**
     * 网关路由
     */
    private final RouteLocator routeLocator;

    /**
     * 网关应用名称
     */
    @Value("${spring.application.name}")
    private String self;

    @Autowired
    public SwaggerConfig(RouteLocator routeLocator) {
        this.routeLocator = routeLocator;
    }

    /**
     * 对于gateway来说这块比较重要 让swagger能找到对应的服务
     *
     * @return
     */
    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        List<String> routeHosts = new ArrayList<>();
        HashMap<String, String> apiMap = new HashMap();
        // 获取所有可用的host：serviceId
        routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
                .filter(route -> !self.equals(route.getUri().getHost()))
                .subscribe(route -> {
                    routeHosts.add(route.getUri().getHost());
                    // 分割网关配置的拦截路径 这里取第一个  /api/user, /api/chat
                    String routeApi = route.getPredicate().toString().split("\\[")[1].split("]")[0].split(",")[0].replace("/**","");
                    apiMap.put(route.getUri().getHost(),routeApi);
                });

        // 记录已经添加过的server
        Set<String> dealed = new HashSet<>();
        routeHosts.forEach(instance -> {
            // 拼接url
            String url = apiMap.get(instance) + SWAGGER2URL;
            if (!dealed.contains(url)) {
                dealed.add(url);
                SwaggerResource swaggerResource = new SwaggerResource();
                swaggerResource.setUrl(url);
                swaggerResource.setName(instance);
                resources.add(swaggerResource);
            }
        });
        return resources;
    }

}

里面的apiMap的key是服务名(chat-websocket)，value是第一个拦截的路径匹配式（/api/chat）

微服务配置

导入依赖

<!--swagger-->
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-boot-starter</artifactId>
     <version>3.0.0</version>
 </dependency>

添加SwaggerConfig

@Configuration
@EnableSwagger2
@EnableOpenApi
public class SwaggerConfig2 implements WebMvcConfigurer {

    //配置了Swagger的Docket的bean实例
    //enable是否启动swagger，如果为False则Swagger不能在浏览器访问
    @Bean
    public Docket docket() {

        // 设置全局响应状态码 (这里的类是我自定义的枚举类，可以删掉这段)
        List<Response> responseList = new ArrayList<>();
        for (StatusCode statusCode : StatusCode.values()) {
            String description = statusCode.getDescription();
            String code = statusCode.getCode().toString();
            responseList.add(new ResponseBuilder().code(code).description(description).build());
        }
        // 支持的通讯协议集合
        Set<String> set = new HashSet<>();
        set.add("https");
        set.add("http");

        return new Docket(
                DocumentationType.SWAGGER_2)
                .enable(true)//定义是否开启swagger，false为关闭，可以通过变量控制
                .apiInfo(apiInfo())//将api的元信息设置为包含在json ResourceListing响应中。
                .select()
                .apis(RequestHandlerSelectors.basePackage("work.xiaohong"))
                //paths()过滤什么路径
                .paths(PathSelectors.any())
                .build()
                .protocols(set)
                //下面这个设置就是在接口的path前加上api
                .pathMapping("/api")
                // 全局响应配置
                .globalResponses(HttpMethod.GET,responseList)
                .globalResponses(HttpMethod.DELETE,responseList)
                .globalResponses(HttpMethod.POST,responseList)
                .globalResponses(HttpMethod.PUT,responseList)
                .globalResponses(HttpMethod.PATCH,responseList)
                .globalResponses(HttpMethod.HEAD,responseList)
                .globalResponses(HttpMethod.OPTIONS,responseList)
                .globalResponses(HttpMethod.TRACE,responseList)
                .securitySchemes(securitySchemes())// 授权信息设置，必要的header token等认证信息
                .securityContexts(securityContexts());// 授权信息全局应用
    }


    //作者信息
    Contact contact = new Contact("小鸿","https://www.xiaohong.work","1990063814@qq.com");

    //配置Swagger 信息 = ApiInfo
    private ApiInfo apiInfo()
    {
        return new ApiInfo("用户微服务",
                "用户微服务用户Api文档",
                "1.0.0",
                "https://www.xiaohong.work",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }

    /**
     * 设置授权信息
     */
    private List<SecurityScheme> securitySchemes()
    {
        List<ApiKey> result = new ArrayList<>();
        ApiKey apiKey = new ApiKey("xiaohong-token","身份令牌" ,"Header" );
        result.add(apiKey);
        return  Collections.singletonList(apiKey);
    }

    /**
     * 授权信息全局应用
     */
    private List<SecurityContext> securityContexts() {
        return Collections.singletonList(
                SecurityContext.builder()
                        //这里第一个参数要对应上面创建的ApiKey的name值
                        .securityReferences(Collections.singletonList(new SecurityReference("xiaohong-token", new AuthorizationScope[]{new AuthorizationScope("global", "身份令牌")})))
                        .build()
        );
    }

}