Как интегрировать Swagger без настройки конфигурации с Джерси 2 - PullRequest
Новая
       9

Как интегрировать Swagger без настройки конфигурации с Джерси 2

0 голосов
/ 01 сентября 2018

Я пытаюсь выполнить настройку Swagger с помощью проекта Jersey 2, размещенного на Tomcat 8.5. Сначала я сгенерировал проект джерси со следующим фрагментом из руководства по началу работы с Джерси (https://jersey.github.io/documentation/latest/getting-started.html):

mvn archetype:generate -DarchetypeArtifactId=jersey-quickstart-webapp
  -DarchetypeGroupId=org.glassfish.jersey.archetypes -DinteractiveMode=false
  -DgroupId=com.example -DartifactId=simple-service-webapp -Dpackage=com.example \
  -DarchetypeVersion=2.27

Затем я добавил зависимости Swagger из руководства по началу работы с swagger (https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Getting-started): 

<dependency>
  <groupId>io.swagger.core.v3</groupId>
  <artifactId>swagger-jaxrs2</artifactId>
  <version>2.0.0</version>
</dependency>
<dependency>
  <groupId>io.swagger.core.v3</groupId>
  <artifactId>swagger-jaxrs2-servlet-initializer</artifactId>
  <version>2.0.0</version>
</dependency>

При попадании в API на http://localhost:8080/simple-service-webapp/webapi/myresource я получаю правильный ответ. Когда я нажимаю http://localhost:8080/simple-service-webapp/webapi/openapi.json, я получаю 404 Not Found.

Есть идеи?

Вот как выглядит мой помпан: 

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<groupId>com.example</groupId>
<artifactId>simple-service-webapp</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>simple-service-webapp</name>

<build>
    <finalName>simple-service-webapp</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>2.5.1</version>
            <inherited>true</inherited>
            <configuration>
                <source>1.7</source>
                <target>1.7</target>
            </configuration>
        </plugin>
    </plugins>
</build>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.glassfish.jersey</groupId>
            <artifactId>jersey-bom</artifactId>
            <version>${jersey.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet-core</artifactId>
        <!-- use the following artifactId if you don't need servlet 2.x compatibility -->
        <!-- artifactId>jersey-container-servlet</artifactId -->
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.inject</groupId>
        <artifactId>jersey-hk2</artifactId>
    </dependency>
    <!-- uncomment this to get JSON support
    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-binding</artifactId>
    </dependency>
    -->
    <dependency>
      <groupId>io.swagger.core.v3</groupId>
      <artifactId>swagger-jaxrs2</artifactId>
      <version>2.0.0</version>
    </dependency>
    <dependency>
      <groupId>io.swagger.core.v3</groupId>
      <artifactId>swagger-jaxrs2-servlet-initializer</artifactId>
      <version>2.0.0</version>
    </dependency>
</dependencies>
<properties>
    <jersey.version>2.27</jersey.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

1 Ответ

0 голосов
/ 02 сентября 2018

Вам все еще нужно зарегистрировать OpenApi ресурсы . Это классы ресурсов JAX-RS, которые обслуживают JSON. Поскольку вы используете web.xml для своей конфигурации, вы можете просто добавить пакет swagger в список пакетов для сканирования. 

<servlet>
    <servlet-name>Jersey Web Application</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>jersey.config.server.provider.packages</param-name>
        <param-value>
            com.example,
            io.swagger.v3.jaxrs2.integration.resources
        </param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

Обратите внимание, что я добавил пакет io.swagger.v3.jaxrs2.integration.resources в список, разделенный запятой. Это скажет Джерси сканировать этот пакет, и он обнаружит и зарегистрирует как AcceptHeaderOpenApiResource, так и OpenApiResource. Разница между ними заключается в том, что первый обслуживает путь /openapi, а формат данных определяется заголовком Accept в запросе, а второй обслуживает путь /openapi.{type:json|yaml}, где формат данных определяется расширение (.json или .yaml) в пути.

...