Jersey 1.19的Swagger JAX-RS给出了“冲突的URI模板”错误

Question

我正在尝试将Swagger添加到使用Jersey 1.19的现有应用程序中。为了在应用程序中添加Swagger，我一直遵循以下指南：https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-1.X-Project-Setup-1.5.

在Apache Tomcat上部署应用程序时，出现以下错误：

SEVERE: Conflicting URI templates. The URI template / for root resource class io.swagger.jaxrs.listing.ApiListingResource and the URI template / transform to the same regular expression (/.*)?

奇怪的是，我的泽西servlet没有部署在根上下文中，而是部署在 /api/*上下文中，如web.xml文件所示：

<servlet>
    <servlet-name>MyApp Service</servlet-name>
    <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>javax.ws.rs.Application</param-name>
        <param-value>app.MyApplication</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>MyApp Service</servlet-name>
    <url-pattern>/api/*</url-pattern>
</servlet-mapping>

我的MyApplication类定义如下：

public class MyApplication extends Application {

private final Set<Object> singletons = new HashSet<Object>();
private final Set<Class<?>> classes = new HashSet<Class<?>>();

public MyApplication() {

    MyResource resource= new MyResource();

    singletons.addAll(Arrays.asList(resource));

    BeanConfig beanConfig = new BeanConfig();
    beanConfig.setBasePath("/api");
    beanConfig.setResourcePackage(getClass().getPackage().getName());
    beanConfig.setTitle("REST API");
    beanConfig.setVersion("1.0.0");
    beanConfig.setScan(true);

    classes.add(io.swagger.jaxrs.listing.ApiListingResource.class);
    classes.add(io.swagger.jaxrs.listing.SwaggerSerializers.class);
}

@Override
public Set<Class<?>> getClasses() {
    return classes;
}

@Override
public Set<Object> getSingletons() {
    return singletons;
}}

我尝试了其他配置，例如在web中定义Swagger servlet。xml文件，而不是使用BeanConfig，但仍然会发生相同的错误。我已经在另一个使用Jersey 2的项目中以这种方式工作，但不幸的是，当前项目必须保留在Jersey 1.19上。以下是pom中定义的招摇依赖项。xml文件：

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-jersey-jaxrs</artifactId>
  <version>1.5.0</version>
</dependency>

任何帮助将不胜感激。

Answer 1

更新2：看起来swagger core的1.5.8版本修复了这个问题。有关详细信息，请参阅此提交。

更新：与其将招摇资源添加为子资源，不如只覆盖路径映射。有关详细信息，请参阅解决方案2。

我面临着完全相同的问题。原因是Swagger资源被映射到root@Path（"/"）公共类ApiListingResources。

一种简单且不灵活的方法是不定义到根路径（“/”）的任何资源映射。

ApiListingResource应获得新的路径映射

package my.api.package.swagger

import javax.ws.rs.Path;

@Path("swagger")
public class ApiListingResource extends io.swagger.jaxrs.listing.ApiListingResource {}

SwaggerSerializers应该得到新包

package my.api.package.swagger;

import javax.ws.rs.ext.Provider;

@Provider
public class SwaggerSerializers extends io.swagger.jaxrs.listing.SwaggerSerializers {}

添加我的。应用程序编程接口。包裹昂首阔步，而不是io。大摇大摆jaxrs。在Swagger包配置中列出。

另一个解决方案是将Swagger移动到另一条路径，允许您的资源映射到您喜欢的任何地方。要实现这一点，您需要：

如果您将应用程序子类化：

public MyApplication() {
    //init BeanConfig
    //add your resource classes

    //classes.add(io.swagger.jaxrs.listing.ApiListingResource.class);
    classes.add(io.swagger.jaxrs.listing.SwaggerSerializers.class);
}

如果您通过web进行配置。xml使用com。太阳运动衫配置。所有物包param：

<servlet>
    <servlet-name>your-rest-api</servlet-name>
    <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>com.sun.jersey.config.property.packages</param-name>
        <param-value>
            {your_application_packages},
            <!--io.swagger.jaxrs.json,-->
            <!--io.swagger.jaxrs.listing-->
        </param-value>
    </init-param>
    <init-param>
        <param-name>com.sun.jersey.config.property.classnames</param-name>
        <param-value>
            io.swagger.jaxrs.listing.SwaggerSerializers,
            io.swagger.jaxrs.json.JacksonJsonProvider
        </param-value>
    </init-param>
</servlet>

顺便说一下，我注意到GF3.1.2.2使用配置的泽西

@Path("/") 
class RootResource {
    @Context ServletContext context;

    @Path("/swagger")
    public ApiListingResource swagger() {
        return new ApiListingSubResource(context);
    }
}

由于ApiListingResources现在不是由jer管理的，所以它没有注入ServletContext。要克服这个问题，您必须将其作为构造函数参数传递，对于该子类ApiListingResources并提供正确的构造函数：

// context has 'default' visibility
// so we need to stay in the same package 
// to be able to access it
package io.swagger.jaxrs.listing;

import javax.servlet.ServletContext;

public class ApiListingSubResource extends ApiListingResource {
    public ApiListingSubResource(ServletContext sc) { this.context = sc; }
}

现在，您的招摇描述符将位于<代码>http://hostname/app-path/swagger/swagger.json，您仍然可以使用根资源。

这条路有点长，但是有用！希望能有所帮助。