3

以下のソリューションで更新!!!
/////////////////////////////////////////////// ////////////
以下の Ron のアドバイスのおかげで、SwaggerConfig の代わりに BeanConfig を使用するようにセットアップを少し変更し、これが機能するようになりました。これを行うには、サーブレットを変更し、Spring がリソースを取得できるように、Spring アプリケーション コンテキスト ファイルに BeanConfig エントリを追加する必要がありました (これが不足していると思われる場所です)。古いコードと新しい/更新されたコードを示すコメントとともに、以下の更新をコードに含めました。SwaggerConfig を使用し続けることもできた可能性があります (おそらく、Spring アプリケーション コンテキスト ファイルに何かが欠けていたのかもしれません) が、BeanConfig は機能するので、そのままにしておきます。
/////////////////////////////////////////////// ////////////

ローカルの REST ベースの Java アプリで Swagger を実行しようとしていますが、かなりの進歩がありました。ただし、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-core_2.10- 1.3.10.jar / swagger-jaxrs_2.10-1.3.10.jar.

http://localhost:9082/mbl/services/api-docs にアクセスすると、次のような json が表示されるようになりました。 

{"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();
        }
    }

}

また、春のアプリケーションコンテキスト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";
      }
      .
      .
      .

必要に応じてさらに情報を提供します。私が何を見逃しているのか、誰にも分かりますか？

どうもありがとう！

4

1 に答える 1

2

核となる問題は、リソースが実際にはスキャンされていないことです。基本的な Swagger レスポンスはすぐにわかりますが、コンテンツを見ると、API 定義が含まれていません。

その結果、表示するものが何もないため、swagger-ui は何も表示できません。

上記の構成にどのように到達したかについて興味がありますが、実際には、統合はより簡単になる可能性があります。Wink に関する特定のドキュメントはありませんが (すべきです)、考え方は JAX-RS 統合のいずれかと非常によく似ています。

次の手順をお勧めします。

  1. swagger-core 1.5 に移行します。これが新しい統合であることは明らかであり、使用しない理由はありません。
  2. wink のサンプルを確認してください。とても簡単に理解できるはずです。
  3. 1.5 のガイドを読んでください- それらは wink 用ではありませんが、それらはすべて似ており、wink を推測することができます。
  4. 役立つ詳細も含まれているため、移行ガイドを確認してください。

これで当面の問題が正確に解決されるわけではないことは理解していますが、この場合はむしろ適切な全体的な解決策を推進したいと思います。

于 2015-05-19T22:47:00.060 に答える