swagger 我如何将微服务领域的主流观点聚合到一个主流观点中

oxcyiej7  于 2022-11-06  发布在  其他
关注(0)|答案(3)|浏览(165)

我试图在我的微服务项目中生成一个swagger,在Api Gateway中将所有的服务swagger聚合成一个swagger。
这里的问题是,当我尝试设置绝对URL时,我收到的输出是***Failed to load API definition. undefined http://localhost:8070/apihttp://localhost:8081/api/v2/api-docs***其中 localhost:8070/api 是API网关的基本URL,localhost:8081/api/v2/api-docs 是微服务的swagger的docs URL。
下面是我的代码:

摇摆配置

package com.rfd.apigateway.swagger;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

import java.util.List;

@Configuration
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfiguration {

    private List<Resource> resources;

    public List<Resource> getResources() {
        return resources;
    }

    public void setResources(List<Resource> resources) {
        this.resources = resources;
    }
}

资源

package com.rfd.apigateway.swagger;

public class Resource {
    private String name;
    private String url;
    private String version;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }
}

文档控制器

package com.rfd.apigateway.swagger;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
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;

@Component
@Primary
@EnableAutoConfiguration
public class DocumentationController implements SwaggerResourcesProvider {

    private SwaggerConfiguration swaggerConfiguration;

    @Autowired
    public DocumentationController(SwaggerConfiguration swaggerConfiguration){
        this.swaggerConfiguration = swaggerConfiguration;
    }

    @Override
    public List get() {
        List resources = new ArrayList<>();
        for(Resource resource : this.swaggerConfiguration.getResources()){
            resources.add(createSwaggerResource(resource));
        }

        return resources;
    }

    private SwaggerResource createSwaggerResource(Resource resource) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(resource.getName());
        swaggerResource.setUrl(resource.getUrl());
        swaggerResource.setSwaggerVersion(resource.getVersion());
        return swaggerResource;
    }
}

最后,应用程序.yml

swagger:
  resources:
    - name: transactions
      url: http://localhost:8081/api/v2/api-docs
      version: 1.0
    - name: payments
      url: http://localhost:8083/api/v2/api-docs
      version: 1.0

下面几张图片可以帮助您了解问题:
Api网关 swagger 的URL x1c 0d1x
微服务api-docs URL

7kqas0il

7kqas0il1#

这里的问题只是springfox版本...我试着把它从2.8.0降级到2.7.0,它运行得很好。看起来这是一个公认的bug,正如你在这里看到的:https://github.com/springfox/springfox/issues/2235
我还必须在微服务中启用cors,但这是另一个问题。

l7mqbcuq

l7mqbcuq2#

我可以使用以下方法解决该问题:https://github.com/varghgeorge/microservices-single-swagger
这个简单的sprintboot微服务可以在一个地方显示你所有的swagger文档。基于YAML配置,它将显示服务列表并为所有服务提供一个文档服务器。在YAML配置中,你可以添加不同的swagger URL。

bfrts1fy

bfrts1fy3#

这个问题在3.0.0版本中再次出现,并且还没有得到解决。大家都在等待3.0.1版本。一个临时的解决方案是下载springfox-swagger-ui.jar。在那里,替换springfox.js。并再次生成jar。然后从主依赖项中排除这个jar,并手动将其删除。

implementation("io.springfox:springfox-boot-starter:3.0.0") {
    exclude(group = "io.springfox", module = "springfox-swagger-ui")
}
implementation(files("libs/springfox-swagger-ui-3.0.0.jar"))

以下是此问题讨论的链接:https://github.com/springfox/springfox/issues/3413您还可以在那里找到一个新的springfox.js文件

相关问题