时间戳

首页 > 解决方案 > 如何将 Swagger 无配置设置与 Jersey 2 集成

maven - 如何将 Swagger 无配置设置与 Jersey 2 集成

问题描述

我正在尝试使用托管在 Tomcat 8.5 上的 Jersey 2 项目进行准系统 Swagger 设置。我首先使用 Jersey 入门指南 ( https://jersey.github.io/documentation/latest/getting-started.html ) 中的以下片段生成了 jersey 项目：

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 入门指南（https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Getting-started）中添加了 Swagger 依赖项：

<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>

当在http://localhost:8080/simple-service-webapp/webapi/myresource 访问 api时，我得到了正确的响应。当我点击http://localhost:8080/simple-service-webapp/webapi/openapi.json我得到一个 404 Not Found。

有任何想法吗？

这是我的 pom 的样子：

<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>

标签： mavenjerseyswagger

解决方案

您仍然需要注册OpenApi 资源。这些是提供 JSON 的 JAX-RS 资源类。由于您使用 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包添加到列表中，以逗号分隔。这将告诉 Jersey 扫描那个包，它会发现并注册AcceptHeaderOpenApiResource和OpenApiResource. 两者的区别在于前者提供路径/openapi，数据格式由Accept请求中的header决定，后者提供路径/openapi.{type:json|yaml}，数据格式由扩展名（.json或.yaml）决定在路径中。

推荐阅读