Swagger UI CORS configuration Java CXF jersey REST API

Question

嗨，我对招摇的用户界面有问题。我有与此类似的配置文件。

<bean id="resourceWriter" class="com.wordnik.swagger.jaxrs.listing.ResourceListingProvider" />
<bean id="apiWriter" class="com.wordnik.swagger.jaxrs.listing.ApiDeclarationProvider" />
<bean id="swaggerResourceJSON" class="com.wordnik.swagger.jaxrs.listing.ApiListingResourceJSON" />
<jaxrs:server id="swaggerAPI" address="/swagger">
    <jaxrs:serviceBeans>
        <ref bean="swaggerResourceJSON"/>
    </jaxrs:serviceBeans>
    <jaxrs:providers>
        <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider"/>
        <bean class="com.ge.aviation.svc.fss.exception.WebExceptionHandler"/>
        <ref bean="resourceWriter"/>
        <ref bean="apiWriter"/>
    </jaxrs:providers>
</jaxrs:server>
<bean id="swaggerConfig" class="com.wordnik.swagger.jaxrs.config.BeanConfig">
    <property name="resourcePackage" value="package.of.my.service"/>
    <property name="version" value="1.0.0"/>
    <property name="basePath" value="http://localhost:8090/"/>
    <property name="title" value="Sample Service"/>
    <property name="description" value="Service for storing, searching, and retrieving files."/>
    <property name="contact" value="[e-mail]"/>
    <property name="scan" value="true"/>
</bean>

然后我的服务器运行完美，并且有招摇UI的终点。 http://localhost:8095/api/api-docs/ 然后我在浏览器中复制此 URL，它将显示 Json 文件。但是我已经在我的 tomcat 中复制了招摇的 UI dist 文件（不是上面提到的相同服务器），然后添加上面的 URL，然后它说Can't read from server. It may not have the appropriate access-control-origin settings.我发现错误的原因 https://github.com/swagger-api/swagger-ui/issues/146 https://github.com/swagger-api/swagger-ui#cors-support 但是我想知道如何为具有api-docs端点的ApiListingResourceJSON类设置cors。

Answer 1

招摇核心项目中的所有示例都包含一个示例文件管理器和如何启用 CORS 支持的配置。

基本上，您将创建以下筛选器：

public class ApiOriginFilter implements javax.servlet.Filter {
  @Override
  public void doFilter(ServletRequest request, ServletResponse response,
      FilterChain chain) throws IOException, ServletException {
    HttpServletResponse res = (HttpServletResponse) response;
    res.addHeader("Access-Control-Allow-Origin", "*");
    res.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
    res.addHeader("Access-Control-Allow-Headers", "Content-Type, api_key, Authorization");
    chain.doFilter(request, response);
  }
  @Override
  public void destroy() {
  }
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
  }
}

并将其添加到您的网络.xml：

  <filter>
    <filter-name>ApiOriginFilter</filter-name>
    <filter-class>com.wordnik.swagger.sample.util.ApiOriginFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>ApiOriginFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

当然，如果您不使用 web.xml还有其他方法可以连接它，但这取决于您的用例。

通过添加所有这些，将在整个应用程序中启用 CORS。

Answer 2

我已经使用这种方式解决了问题。罗恩的回答也正确，但我没有使用任何网络.xml配置。这是答案.org.apache.cxf.rs.security.cors.CrossOriginResourceSharingFilter作为提供添加到服务器，并将@CrossOriginResourceSharing(allowAllOrigins = true, allowCredentials = true)注释添加到 REST API 控制器。