Java swagger 与 JaxRS 抛出错误

Question

我按照此处找到的指南进行操作: 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>

注释发现很好，所以我假设 POM 工作正常

对于 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}/service/api-docs

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 初始化参数。

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

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

我没有收到任何错误，但我确实得到了无用的网页:

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

Answer 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中更改url:“http://petstore.swagger.wordnik.com/api/api-docs”，部分到您的 api 端点 http://localhost:8080/ScholarlyItemService/service/api-docs ，您将在调用 http://localhost:8080/ScholarlyItemService/docs 时获取 api 文档/index.html