Java招摇与JaxRS抛出错误

时间:2014-03-06 17:05:32

标签: java maven jersey swagger

我按照这里的指南: https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart

这是我的POM:

<!--  SWAGGER -->
<dependency>
  <groupId>com.wordnik</groupId>
  <artifactId>swagger-jersey-jaxrs_2.10</artifactId>
  <version>1.3.0</version>
</dependency>

注释很好,所以我假设P​​OM工作正常

对于WEB.xml,我按照指南尝试了多项工作:

 <servlet>
            <servlet-name>jersey-serlvet</servlet-name>
            <servlet-class>
                com.sun.jersey.spi.spring.container.servlet.SpringServlet
            </servlet-class>
            <init-param>
                <param-name>com.sun.jersey.config.property.packages</param-name>
                <param-value>com.thomsonreuters.ips.service;com.wordnik.swagger.jersey.listing</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <servlet-mapping>
            <servlet-name>jersey-serlvet</servlet-name>
            <url-pattern>/service/*</url-pattern>
        </servlet-mapping>

<!-- SWAGGER serverlet? -->
<servlet>
          <servlet-name>JerseyJaxrsConfig</servlet-name>
          <servlet-class>com.wordnik.swagger.jersey.config.JerseyJaxrsConfig</servlet-class>
          <init-param>
            <param-name>api.version</param-name>
            <param-value>1.0.0</param-value>
          </init-param>
          <init-param>
            <param-name>swagger.api.basepath</param-name>
            <param-value>http://localhost:8080/{PROJECTNAME}</param-value>
          </init-param>
          <load-on-startup>2</load-on-startup>
        </servlet>

但是当我尝试触及时,这会引发一个疯狂的错误:

本地主机:8080 / {PROJECTNAME} /服务/ API-文档

HTTP Status 500 - java.lang.NoSuchMethodError: com.wordnik.swagger.annotations.ApiOperation.authorizations()Ljava/lang/String;

接下来我在googleverse周围看到了将web.xml修改为以下内容:

<servlet>
        <servlet-name>jersey-serlvet</servlet-name>
        <servlet-class>
            com.sun.jersey.spi.spring.container.servlet.SpringServlet
        </servlet-class>
         <init-param>
            <param-name>api.version</param-name>
            <param-value>2.0</param-value>
          </init-param>
        <init-param>
            <param-name>com.sun.jersey.config.property.packages</param-name>
            <param-value>com.thomsonreuters.ips.service;com.wordnik.swagger.jaxrs;</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>jersey-serlvet</servlet-name>
        <url-pattern>/service/*</url-pattern>
    </servlet-mapping>

注意api.version和新的jaxrs init param。

当发生这种情况时,我会去

http://localhost:8080/ScholarlyItemService/service/api-docs 

我没有错误,但我确实得到了无用的网页:

{"apiVersion":"0.0","swaggerVersion":"1.2"}

1 个答案:

答案 0 :(得分:1)

我想你几乎拥有它。你看到的不是一个无用的网页,而是由swagger作为json文档构建的服务文档。您必须按照快速入门指南中的说明注释您的代码。这应该出现在本文件中。

您可能真正想要的是Swagger UI:http://swagger.wordnik.com/以可读的方式查看此文档。

我花了一会儿,但我跑了。您必须从此处下载:https://github.com/wordnik/swagger-ui,并将dist文件夹中的内容复制到/ webapp文件夹。然后,您可以在浏览器中打开包含的index.html。在我的情况下,我无法直接访问此文档,因此我必须将dist'内容放在子文件夹(例如/ docs)中,并将其从web.xml中的servlet映射中排除,如下所述:http://blog.ericdaugherty.com/2010/02/excluding-content-from-url-pattern-in.html

在index.html中更改网址:“http://petstore.swagger.wordnik.com/api/api-docs”, 部分到您的api端点http://localhost:8080/ScholarlyItemService/service/api-docs,您将在致电http://localhost:8080/ScholarlyItemService/docs/index.html时获得api文档