多个Swagger端点用于API版本控制

Question

我正在使用以下技术：

• Java 7
• 雄猫7
• JAX-RS（泽西岛2）
• 昂首阔步2
• 春天4.3.3发布

我的后端托管各种类型的版本化REST API。 我们有一个v1和v2 REST API上下文基本路径（/ api / v1和/ api / v2）。 我们托管这两个不同API版本的方式是通过两个不同的Jersey资源配置（两个不同的servlet）。 这一切都作为一个WAR文件部署到我们的Web应用程序服务器（我们使用Tomcat7）中的一个Web应用程序中。

我们所做的基本示例：

@ApplicationPath("/api/v2")
@Configuration
public class RestApiV2JerseyConfig extends ResourceConfig {

    public RestApiV2JerseyConfig() {
        ...
        register(ApiListingResource.class);
        register(SwaggerSerializers.class);
    }

    @Bean
    public void swaggerV2Bean() {
        BeanConfig beanConfig = new BeanConfig();
        beanConfig.setBasePath("/api/v2/);
        beanConfig.setResourcePackage("com.example.rest.v2");
        beanConfig.setScan(true);
        return beanConfig;
    }

}

@ApplicationPath("/api/v1")
@Configuration
public class RestApiV1JerseyConfig extends ResourceConfig {

    public RestApiV1JerseyConfig() {
        ... 
        register(ApiListingResource.class);
        register(SwaggerSerializers.class);
    }

    @Bean
    public void swaggerV1Bean() {
        BeanConfig beanConfig = new BeanConfig();
        beanConfig.setBasePath("/api/v1/);
        beanConfig.setResourcePackage("com.example.rest.v1");
        beanConfig.setScan(true);
        return beanConfig;
    }


}

每个REST API均在上述各种配置中进行了相应注册。

现在，我想要做的是为每个servlet托管Swagger。 这是不可能的，对吗？ 当我尝试执行此操作时，Swagger配置将相互覆盖，并且每个端点将返回相同的内容。 意思是， https：//ip-address/api/v1/swagger.json和https：//ip-address/api/v2/swagger.json返回完全相同的响应（v1或v2 JSON，具体取决于哪个先注册）。

因此，似乎正在发生的事情是可以为每个servlet成功地托管端点，但是托管的内容对于每个servlet来说都不是唯一的。 或者，我可能只是把一些小东西弄乱了，还没有注意到。

各种事物的版本：

• swagger-jersey2-jaxrs 1.5.2-M2
• 球衣2.23.1

我在这里想念什么？ 通过我提供的代码片段，这很容易重现。 有没有其他人能够成功完成我想做的事情？

Answer 1

是的，您可以执行此操作，但是您需要使用web.xml servlet config方法（至少，我还没有弄清楚如何使用另一种方法）。

BeanConfig的更改：

在RestApiV1JerseyConfig中

beanConfig.setConfigId("v1");  
beanConfig.setContextId("v1");
beanConfig.setScannerId("v1");

在RestApiV2JerseyConfig中

beanConfig.setConfigId("v2");  
beanConfig.setContextId("v2");
beanConfig.setScannerId("v2");

web.xml（每个servlet一个）：

<!-- v1 -->
<init-param>
    <param-name>swagger.scanner.id</param-name>
    <param-value>v1</param-value>
</init-param>
<init-param>
    <param-name>swagger.config.id</param-name>
    <param-value>v1</param-value>
</init-param>
<init-param>
    <param-name>swagger.use.path.based.config</param-name>
    <param-value>v1</param-value>
</init-param>

<!-- v2 -->
<init-param>
    <param-name>swagger.scanner.id</param-name>
    <param-value>v2</param-value>
</init-param>
<init-param>
    <param-name>swagger.config.id</param-name>
    <param-value>v2</param-value>
</init-param>
<init-param>
    <param-name>swagger.use.path.based.config</param-name>
    <param-value>v2</param-value>
</init-param>