Swagger UI与Camel集成。。。无法访问索引。端口上的html

Question

我下载的dist文件夹重命名为swagger并更新index.html但我无法通过我的应用程序端口访问用户界面：http://localhost：${port}/${contextPath}/swagger/index.html

但如果我打字http://localhost:${port}/api doc，我得到了swagger-json转储。

我可以访问索引。html，如果转到该文件并使用浏览器手动打开它。如何访问索引。html使用我的应用程序端口？

http://localhost:${port}/${contextPath}/swagger/index。html

Answer 1

一个更简单的解决方案是添加一个web.xml文件，将资源移动到 /webapp目录，在web.xml中添加以下过滤器

<filter>
  <filter-name>RestSwaggerCorsFilter</filter-name>
  <filter-class>org.apache.camel.swagger.servlet.RestSwaggerCorsFilter</filter-class>
</filter>

<filter-mapping>
  <filter-name>RestSwaggerCorsFilter</filter-name>
  <url-pattern>/api-docs/*</url-pattern>
  <url-pattern>/rest/*</url-pattern> 
</filter-mapping>

有关详细信息，请参阅驼峰招摇文档：http://camel.apache.org/swagger-java.html

Answer 2

我使用Camel Jetty作为REST组件。对于jetty，您只需要添加一个额外的ResourceHandler来处理SwaggerUI资源。下面使用Spring xml语言配置REST：

<restConfiguration component="jetty" host="{{rest_hostname}}" port="{{rest_listen_port}}"
                       bindingMode="off" apiContextPath="api-docs" apiContextListing="true"
                       enableCORS="true">
        <!--ResourceHandler to handle Swagger UI contents on the jetty-->
        <endpointProperty key="handlers" value="swaggerUIHandler"/>
......
......
</restConfiguration>

我在webjars提供的jar中使用了swaggerUI。配置处理程序bean：

<bean id="swaggerUIHandler" class="com.yifanwu.examples.camel.JettyResourceHandlerFactory" factory-method="buildResourceHandler">
        <!--your resource path is just "swagger" assuming it is on the classpath-->
        <constructor-arg name="resourcePath" value="META-INF/resources/webjars"/>
</bean>

豆子工厂：

public class JettyResourceHandlerFactory {
    public static ResourceHandler buildResourceHandler(String resourcePath) throws Exception {
        ResourceHandler rh = new ResourceHandler();
        rh.setResourceBase(JettyResourceHandlerFactory.class.getClassLoader()
                .getResource(resourcePath)
                .toURI().toString());
        return rh;
    }
}

这里的完整示例：github

Answer 3

您需要公开一个将返回index.html文件的endpoint。尝试将以下内容添加到RouteBuilder：

rest("/swagger")
  .produces("text/html")
  .get("/index.html")
  .responseMessage().code(200).message("Swagger UI").endResponseMessage()
  .to("direct://get/swagger/ui/path");

from("direct://get/swagger/ui/path")
  .routeId("SwaggerUI")
  .setBody().simple("resource:classpath:/swagger/index.html");

第一个路由定义了接受GET请求并返回text/html的restfulendpoint /swagger/index.html。

第二条路由使用Camel的简单组件读取实际索引。将html导入Exchange邮件正文。

因此，如果您转到localhost：${port}/${contextPath}/swagger/index。html，它应该加载索引。html文件正确。

请注意，inside Index。html您需要替换将返回API的JSON转储的URL，以便Swagger UI可以呈现它。