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

网关配置

  1. 引入swagger相关依赖
<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

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

  1. 添加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)

微服务配置

  1. 导入依赖
<!--swagger-->
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-boot-starter</artifactId>
     <version>3.0.0</version>
 </dependency>
  1. 添加SwaggerConfig
在Docket里的一个pathMapping配置我这里配成/api是因为swagger被网关接手了后,那所有请求的请求地址都需要经过网关,我这有个习惯就是在经过网关前的路径都加了/api前缀,在网关处再过滤掉,如果没有或有其他习惯的,可以自己看着写

测试

网关访问 http://localhost:8001/swagger-ui/index.html

先来测试一个接口试试

可以看到,这个接口是需要提供token进行权限验证的,同时,这里的请求路径都是从网关的地址再凭借上我们自己加的/api,最后再拼接上接口的请求路径

那我们添加上token再试一遍 完成后这两把锁都锁上了,表示添加成功 如果没有都锁上,就要去看看配置文件里的两个名字是否没有匹配上了

再次测试 可以看到这次将我们输入的token带入了请求头中 我们使用调试工具看看 可以看到确实添加进去了 这里响应权限不足那是后端的处理逻辑 换一个有权限的账号token即可 这里我有不实验了 另一个服务我也不测了(写之前我已经测试过了,就不展示了) 饿了,吃饭去了

经验分享 程序员 微信小程序 职场和发展