Swagger UI在index.html頁面上不顯示任何內容

Question

更新以下解決方案!!!
////////////////////////////////////////////////// ////////////
感謝Ron的建議，我略微修改了我的設置，使用BeanConfig而不是SwaggerConfig，並使其正常工作。 為了做到這一點，我不得不修改servlet，並且（這是我認為缺少的部分）將BeanConfig條目添加到spring應用程序上下文文件中，以便spring獲取資源。 我在下面的更新中包含了我的代碼中的注釋，顯示了舊的和新的/更新的代碼。 有可能我可以繼續使用SwaggerConfig（也許我剛剛在Spring應用程序上下文文件中遺漏了一些東西？）但是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罐子：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>

這是我的Resource類的片段：

@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唯一重要的部分（我可以告訴）看起來像這樣：

  <script type="text/javascript">
    $(function () {
      var url = window.location.search.match(/url=([^&]+)/);
      if (url && url.length > 1) {
        url = url[1];
      } else {
        url = "http://" + window.location.hostname + (window.location.port ? ':'+ window.location.port: '') + "/mbl/services/api-docs";
      }
      .
      .
      .

我很樂意根據需要提供更多信息。 有誰知道我可能會缺少什么？

非常感謝！

Answer 1

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

結果，swagger-ui無法展示任何東西，因為沒有任何東西可以顯示。

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

我建議采取以下步驟：

1. 遷移到swagger-core 1.5。 很明顯，這是一個新的集成，沒有理由不使用它。
2. 看看眨眼樣本 - 應該很容易理解。
3. 閱讀1.5的指南 - 它們不是為了眨眼，但它們都很相似，你可以推斷為眨眼。
4. 請查看遷移指南 ，因為它還包含可能對您有所幫助的詳細信息。

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