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>

но это выдает дикую ошибку, когда я пытаюсь достичь:

LOCALHOST:8080/{Projectname}/ сервис / апи-документы

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: http://swagger.wordnik.com/ чтобы увидеть этот документ в удобочитаемой форме.

Это заняло у меня мгновение, но я запустил его. Вы должны скачать отсюда: https://github.com/wordnik/swagger-ui и скопировать содержимое из папки dist в папку / webapp. Затем вы можете открыть содержащийся index.html в браузере. В моем случае я не мог получить доступ к этому документу напрямую, поэтому мне пришлось поместить содержимое dist в подпапку (например, / docs) и исключить это из моего отображения сервлета в web.xml, как описано здесь: 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 и вы получите документацию по API при звонке http://localhost:8080/ScholarlyItemService/docs/index.html