Question

我将Swagger-ui集成到我的wildfly应用程序中。

通过maven使用以下（相关）依赖项配置项目：

    <dependency>
      <groupId>io.swagger.core.v3</groupId>
      <artifactId>swagger-jaxrs2</artifactId>
      <version>2.0.0</version>
    </dependency>
    <dependency>
      <groupId>io.swagger.core.v3</groupId>
      <artifactId>swagger-jaxrs2-servlet-initializer</artifactId>
      <version>2.0.0</version>
    </dependency>
    <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>swagger-ui</artifactId>
        <version>3.23.2</version>
    </dependency>

我还从webjar中提取了swagger-ui.html页面，并自定义了javascript以如下方式连接到我的服务器（请参见url）：

window.onload = function() {
  // Begin Swagger UI call region
  const ui = SwaggerUIBundle({
    url: "doc/openapi.json",
    dom_id: "#swagger-ui",
    deepLinking: true,
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  })
  // End Swagger UI call region

  window.ui = ui
}

swagger-ui运行良好，它显示了我的端点列表。但是，当我尝试连接到端点时，它失败了，因为用于连接的URL不包含我的应用程序的上下文路径（此处为 myApp ），它将尝试与以下对象进行连接：

curl -X GET "http://localhost:8080/aop/hello/version" -H "accept: */*"

但是应该是：

curl -X GET "http://localhost:8080/myApp/aop/hello/version" -H "accept: */*"

我发现缺少的部分被命名为basePath，但是我没有找到将其添加到Wildfly应用程序中的任何解决方案。

更新：在documentation之后，似乎basePath来自Swagger，OpenApi使用 server 。然后我尝试了：

@ApplicationPath("/api")
public class ApplicationConfig extends Application 
{
    public ApplicationConfig(@Context ServletConfig servletConfig) {
        // Swagger Configuration
        super();
        OpenAPI oas = new OpenAPI()
                .servers(Collections.singletonList(new Server().url("http://localhost:8080/my_app")));
        Info info = new Info()
                .title("Swagger");

        oas.info(info);
        SwaggerConfiguration oasConfig = new SwaggerConfiguration()
                .openAPI(oas)
                .prettyPrint(true);

        try {
            new JaxrsOpenApiContextBuilder<>()
                    .servletConfig(servletConfig)
                    .application(this)
                    .openApiConfiguration(oasConfig)
                    .buildContext(true);
        } catch (OpenApiConfigurationException e) {
            throw new ConfigurationException(e.getMessage(), e);
        }
    }
}

但是仍然没有考虑。

有线索吗？

谢谢：-）

Answer 1

最后，我使它工作了，但是没有使用Java配置，该配置没有考虑（在调试中看到），而是在应用程序的类路径中使用了配置文件 openapi.yaml 。< / p>

文件如下：

prettyPrint: true
cacheTTL: 0
openAPI:
  servers:
    - url: /my_app
  info:
    version: '1.0'
    title: Swagger application

现在正确处理了服务器的网址。

但是我仍然很想知道对于Java配置应该是正确的解决方案。

Answer 2

我也遇到了同样的问题，由于某种原因，您使用openapi.yaml的解决方案也对我不起作用。

然后，我发现您可以将Server批注与服务/资源类一起使用：

@Path("/myservice")
@Server(url="/my_app")
public interface MyService {
...
}

Answer 3

在全局级别提供，它在Java中工作正常

@OpenAPIDefinition(servers = @Server(url="/my_app"))
@ApplicationPath("api")
public class ApplicationConfig extends Application {
}

如何在Wildfly中的Swagger 3.0中定义basePath

3 个答案: