多个Swagger2Feature实例的集成

Question

我正在尝试创建2个不同上下文的Swagger实例：

http://localhost:8080/app/rest1/swagger.json

<context:component-scan base-package="org.app.rest.cxf.service"/>  

<bean id="swagger2customizer" class="org.apache.cxf.jaxrs.swagger.Swagger2Customizer">
    <property name="dynamicBasePath" value="true"/>
    <property name="replaceTags" value="true"/>
</bean>
<bean id="swagger2Feature" class="org.apache.cxf.jaxrs.swagger.Swagger2Feature">
    <property name="title" value="Test"/>
    <property name="version" value="1.0"/>
    <property name="description" value="Test 1.0"/>    
    <property name="contact" value="[e-mail]"/>    

    <property name="resourcePackage" value="org.app.rest.api.service"/>
    <property name="scanAllResources" value="true"/>
    <property name="activateOnlyIfJaxrsSupported" value="true"/>

    <property name="customizer" ref="swagger2customizer"/>
</bean>

<jaxrs:server id="container" address="/"
                basePackages="org.app.rest.api.service, org.app.rest.cxf.service" 
                staticSubresourceResolution="true">
    <jaxrs:properties>
      <entry key="search.lax.property.match" value="true"/>
      <entry key="convert.wadl.resources.to.dom" value="false"/>
    </jaxrs:properties> 
    <jaxrs:inInterceptors>
      <ref bean="gzipInInterceptor"/>
      <ref bean="validationInInterceptor"/>
    </jaxrs:inInterceptors>         
    <jaxrs:outInterceptors>
      <ref bean="gzipOutInterceptor"/>
      <ref bean="validationOutInterceptor"/>
    </jaxrs:outInterceptors>
    <jaxrs:providers>
      <ref bean="dateParamConverterProvider"/>
      <ref bean="jaxbProvider"/>
      <ref bean="jsonProvider"/>
      <ref bean="exceptionMapper"/>
      <ref bean="searchContextProvider"/>
      <ref bean="addDomainFilter"/>
      <ref bean="addETagFilter"/>
      <ref bean="wadlGenerator"/>
    </jaxrs:providers>
    <jaxrs:features>
      <ref bean="swagger2Feature"/>
    </jaxrs:features>
</jaxrs:server>

<context:component-scan base-package="com.app2.rest.cxf.service"/>  

<bean id="swagger2customizer2" class="org.apache.cxf.jaxrs.swagger.Swagger2Customizer">
    <property name="dynamicBasePath" value="true"/>
    <property name="replaceTags" value="true"/>
</bean>
<bean id="swagger2Feature2" class="org.apache.cxf.jaxrs.swagger.Swagger2Feature">
    <property name="title" value="Test"/>
    <property name="version" value="1.0"/>
    <property name="description" value="Test 1.0"/>    
    <property name="contact" value="[e-mail]"/>    

    <property name="resourcePackage" value="com.app2.rest.api.service"/>
    <property name="scanAllResources" value="true"/>
    <property name="activateOnlyIfJaxrsSupported" value="true"/>

    <property name="customizer" ref="swagger2customizer2"/>
</bean>

<jaxrs:server id="container" address="/"
                basePackages="com.app2.rest.api.service, com.app2.rest.cxf.service" 
                staticSubresourceResolution="true">
    <jaxrs:properties>
      <entry key="search.lax.property.match" value="true"/>
      <entry key="convert.wadl.resources.to.dom" value="false"/>
    </jaxrs:properties> 
    <jaxrs:inInterceptors>
      <ref bean="gzipInInterceptor"/>
      <ref bean="validationInInterceptor"/>
    </jaxrs:inInterceptors>         
    <jaxrs:outInterceptors>
      <ref bean="gzipOutInterceptor"/>
      <ref bean="validationOutInterceptor"/>
    </jaxrs:outInterceptors>
    <jaxrs:providers>
      <ref bean="dateParamConverterProvider"/>
      <ref bean="jaxbProvider"/>
      <ref bean="jsonProvider"/>
      <ref bean="exceptionMapper"/>
      <ref bean="searchContextProvider"/>
      <ref bean="addDomainFilter"/>
      <ref bean="addETagFilter"/>
      <ref bean="wadlGenerator"/>
    </jaxrs:providers>
    <jaxrs:features>
      <ref bean="swagger2Feature2"/>
    </jaxrs:features>
</jaxrs:server>

web.xml

<servlet>
    <servlet-name>AppSwaggerCXFServlet</servlet-name>
    <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
    <init-param>
        <param-name>config-location</param-name>
        <param-value>classpath*:/context2.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup> 
</servlet>
<servlet-mapping>
    <servlet-name>AppSwaggerCXFServlet</servlet-name>
    <url-pattern>/sih/*</url-pattern>
</servlet-mapping>

问题是，第二个URL http://localhost:8080/app/rest2/Swagger.JSON生成一个JSON，所有endpoint都在第一个Swagger配置的包下（所以在org.app.rest.api.service下，而不是com.app2.rest.api.service)。

你能帮我弄个正确的配置吗？

谢谢

Answer 1

TL；DR：

添加您的swagger2feature bean配置：

<property name="usePathBasedConfig" value="true"/>

或者在配置bean中创建Swagger2Feature编程：

feature.setUsePathBasedConfig(Boolean.TRUE);

来自CXF的Swagger2Feature允许指定SwaggerContextService的属性，您已经了解了它：“UsePathBasedConfig”的默认值为false，这意味着所有的SwaggerConfig都用相同的键“swagger.config.id.default”放入SwaggerConfigLocator中，这意味着它们相互覆盖。

通过在Swagger2Feature中启用该特性，配置可以独立管理，并且每个Swagger生成过程都可以很好地访问。

我真的不知道为什么默认情况下没有启用它，因为仅使用一个启用的入口点就这样管理它并不是问题。