Swagger用戶界面不能顯示index.html頁面上的任何內容頁面

Question

用下面的解決方案進行更新!!!
/////////////////////////////////////////////// //////////////
感謝Ron下面的建議，我稍微修改了我的設置，以使用BeanConfig而不是SwaggerConfig並獲得了此工作。爲了做到這一點，我不得不修改servlet，並且（這是我認爲缺失的部分）將BeanConfig條目添加到Spring應用程序上下文文件中，以便Spring獲取資源。我在下面的代碼中添加了更新，並在我的代碼中顯示了新舊代碼的更新。有可能我可以繼續使用SwaggerConfig（也許我只是在這個春天的應用程序上下文文件中丟失了一些東西），但是BeanConfig的工作原理讓我可以保持原樣。
//////////////////////////////////////////////// //////////////

我想讓Swagger與我的本地基於REST的Java應用程序一起運行，並取得了相當大的進展。不過，當我試圖讓Swagger UI工作時，我似乎錯過了一些簡單的東西。

每當我真正打到這個地址：http://localhost:9082/mbl/index.html我得到了頂部的小綠色招搖頭，但一個空白的白色身體，沒有下面的內容。我不應該在頁面正文中看到更多嗎？我的堆棧是這樣的：Java 6/Wink/Spring 3.1/Jackson 2.5/JAX-RS（JSR-311），我使用了以下Swagger jar：swagger-annotations-1.3.10.jar/swagger-annotations-1.3.10.jar/swagger- core_2.10-1.3.10.jar/swagger-jaxrs_2.10-1.3.10.jar。

現在，我已經成功地得到一些JSON顯示，看起來像這樣當我打http://localhost:9082/mbl/services/api-docs：

{"apiVersion":"1.0","swaggerVersion":"1.2","info":{"title":"Java API","description":"The following documentation contains the REST Service API useful for interacting with web services.","termsOfServiceUrl":"terms of service","contact":"email@test.com","license":"license type","licenseUrl":"license url"}} 

我可以看到，這是被從我SwaggerServlet.java看起來像這樣產生的：

package com.somewhere.mblsvc.web; 

import... 

public class SwaggerServlet extends HttpServlet { 

    private static final long serialVersionUID = 1L; 

    /* additional working code */ 
    BeanConfig beanConfig; 

    public void setBeanConfig(BeanConfig beanConfig) { 
     this.beanConfig = beanConfig; 
    } 
    /* end additional working code */  

    @Override 
    public void init(ServletConfig servletConfig) { 
     try { 
     /* code from original post*/ 
     // SwaggerConfig swaggerConfig = new SwaggerConfig(); 
     // ConfigFactory.setConfig(swaggerConfig); 
     // swaggerConfig.setBasePath("/mbl/services"); 
     // swaggerConfig.setApiVersion("1.0"); 
     // swaggerConfig.setApiInfo(new ApiInfo("Java API", "The following //documentation contains the REST Service API useful for interacting with web //services.", "terms of service", "email@test.com", "license type", "license //url")); 
     // ScannerFactory.setScanner(new DefaultJaxrsScanner()); 
     // ClassReaders.setReader(new DefaultJaxrsApiReader()); 
     /* end code from original post*/ 

     /* updated working code */ 
     beanConfig.setBasePath("/mbl/x-services"); 
     beanConfig.setVersion("1.0"); 
     beanConfig.setResourcePackage("com.somewhere.mblsvc.resources"); 
     beanConfig.setScan(true); 
     /* end updated working code */ 

     } catch (Exception e) { 
      e.printStackTrace(); 
     } 
    } 

} 

而且，我已經在我的Spring應用程序上下文XML文件如下：

<bean class="org.apache.wink.spring.Registrar"> 
    <property name="classes"> 
     <set value-type="java.lang.Class"> 
     </set> 
    </property> 
    <property name="instances"> 
     <set> 
      <ref local="jaxbProvider" /> 
      <ref local="apiDeclarationProvider" /> 
      <ref local="apiListingResourceJson" /> 
      <ref local="resourceListingProvider" /> 
     </set> 
    </property> 

<!-- Jackson Providers --> 
<bean id="jaxbProvider" class="com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider" > 
    <property name="mapper" ref="jacksonObjectMapper"/> 
</bean> 

<bean id="jacksonObjectMapper" class="com.fasterxml.jackson.databind.ObjectMapper" > 
    <property name="annotationIntrospector" ref="jacksonAnnotationIntrospector" /> 
</bean> 

<bean id="jacksonAnnotationIntrospector" class="com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair" > 
    <constructor-arg ref="primaryAnnotationIntrospector" /> 
    <constructor-arg ref="secondaryAnnotationIntrospector" /> 
</bean> 

<bean id="primaryAnnotationIntrospector" class="com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector" /> 
<bean id="secondaryAnnotationIntrospector" class="com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector" /> 

<!-- Swagger Configuration and Providers --> 

<!-- additional working code --> 
<bean id="beanConfig" class="com.wordnik.swagger.jaxrs.config.BeanConfig"> 
    <property name="title" value="Java API"/> 
    <property name="version" value="1.0" /> 
    <property name="basePath" value="/mbl/services"/> 
    <property name="resourcePackage" value="com.somewhere.mblsvc.resources"/> 
    <property name="scan" value="true"/> 
</bean> 
<!-- end additional working code --> 

<bean id="apiDeclarationProvider" class="com.wordnik.swagger.jaxrs.listing.ApiDeclarationProvider" /> 
<bean id="apiListingResourceJson" class="com.wordnik.swagger.jaxrs.listing.ApiListingResourceJSON" /> 
<bean id="resourceListingProvider" class="com.wordnik.swagger.jaxrs.listing.ResourceListingProvider" /> 

我的web.xml文件看起來是這樣的：

<!-- REST servlet that dispatches to the App (resource class). Remove Init params entry containing application file --> 
<servlet> 
    <servlet-name>Wink Servlet</servlet-name> 
    <servlet-class>org.apache.wink.server.internal.servlet.RestServlet</servlet-class> 
</servlet> 
<servlet-mapping> 
    <servlet-name>Wink Servlet</servlet-name> 
    <url-pattern>/services/*</url-pattern> 
</servlet-mapping> 

<!-- Enabling Swagger servlet --> 
<servlet> 
    <servlet-name>Swagger Servlet</servlet-name> 
    <servlet-class>com.somewhere.mblsvc.web.SwaggerServlet</servlet-class> 
    <load-on-startup>-1</load-on-startup> 
</servlet> 
<servlet-mapping> 
    <servlet-name>Swagger Servlet</servlet-name> 
    <url-pattern>/api-docs</url-pattern> 
</servlet-mapping> 

這裏是我的資源類的一個片段：

@Path("test") 
@Api(value ="test", description="Test Services") 
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) 
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) 
public class TestResource { 

. 
. 
. 

    @GET 
    @Path("testInfo") 
    @ApiParam(defaultValue="you would put test case input here for a post") 
    @ApiOperation(value="Composite service returning extensive test information", response=com.somewhere.mblsvc.messages.test.testinfo.pojo.UserResponseMessage.class) 
    @ApiResponses(value={ 
      @ApiResponse(code=200, message="OK"), 
      @ApiResponse(code=500, message="Internal Error") 
    }) 
    @JsonSerialize(include=JsonSerialize.Inclusion.ALWAYS) 
    public Response getTestInfo(@Context HttpHeaders headers, 
      @CookieParam(value = "testBrand") String testBrand) { 
. 
. 
. 

最後，我的index.html唯一的重要組成部分（即我可以告訴根據需要

我會很樂意供應任何信息）是這樣的。有誰知道我可能會錯過什麼？

非常感謝！

Answer 1

核心問題是您的資源沒有真正掃描。你現在確實得到的是基本的Swagger響應，但是如果你看看內容，它沒有API定義。

因此，swagger-ui無法顯示任何內容，因爲沒有任何內容可以顯示。

雖然我很好奇你如何得到上面的配置，但事實是，集成可以更簡單。我們沒有關於Wink的具體文檔（我們應該），但這個想法與任何JAX-RS集成非常相似。

我建議以下步驟：

1. 遷移到招搖核心1.5。很明顯，這是一個新的整合，沒有理由不使用它。
2. 退房wink sample - 應該是真的容易關注。
3. 閱讀guides 1.5 - 他們不是眨眼，但他們都是相似的，你可以推斷眨眼。
4. 檢查migration guide，因爲它還包含可能會幫助你的詳細信息。

我意識到這並不能完全解決問題，但我寧願在這種情況下推廣正確的整體解決方案。