Jersey + SwaggerUI 不会创建 swagger.json 文件

Question

我在尝试使用 SwaggerUI 时遇到了一些问题，因为 Swagger 不会生成“swagger.json”文件

我正在使用 Eclipse 和 Tomcat 8，我从 here 下载了定义，并按照

中的说明进行操作

Swagger-Core-Jersey-2.X-Project-Setup-1.5

据我了解，有 3 种方法可以根据您的 JERSEY 配置在本地存储库中配置 swagger 我跟着这个“Using Jersey 2 container Servlet or Filter (with web.xml)” 这些是我为该项目所做的步骤

1.- 使用这个 Maven 原型创建了一个 Jersey 项目

mvn archetype:generate -DarchetypeGroupId=org.glassfish.jersey.archetypes -DarchetypeArtifactId=jersey-quickstart-webapp -DarchetypeVersion=2.22.1

2.- 将此 SwaggerUI 依赖项添加到我的 POM 文件中

        <dependency>
          <groupId>io.swagger</groupId>
          <artifactId>swagger-jersey2-jaxrs</artifactId>
          <version>1.5.0</version>
        </dependency>

3.- 我修改了 Web.xml 文件，添加了 Swagger “param-value”（注意我的资源在包 com.api 中，并且“url-pattern”值是“api”）如下来自

的指示

包扫描--具体的类选择

    <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>io.swagger.jaxrs.listing,com.api</param-value>          
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>


    <servlet-mapping>
        <servlet-name>Jersey Web Application</servlet-name>
        <url-pattern>/api/*</url-pattern>
    </servlet-mapping>

4.- 最后我将 Swagger Servlet 添加到 Web.xml 文件中，这是完整的 xml 文件（注意“swagger.api.basepath”值）

<?xml version="1.0" encoding="UTF-8"?>
<!-- This web.xml file is not required when using Servlet 3.0 container,
     see implementation details http://jersey.java.net/nonav/documentation/latest/jax-rs.html -->
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">


    <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>io.swagger.jaxrs.listing,com.api</param-value>          
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>


    <servlet-mapping>
        <servlet-name>Jersey Web Application</servlet-name>
        <url-pattern>/api/*</url-pattern>
    </servlet-mapping>

    <servlet>
        <servlet-name>Jersey2Config</servlet-name>
        <servlet-class>io.swagger.jersey.config.JerseyJaxrsConfig</servlet-class>
        <init-param>
            <param-name>api.version</param-name>
            <param-value>1.0</param-value>
        </init-param>
        <init-param>            
            <param-name>swagger.api.basepath</param-name>
            <param-value>http://localhost:8080/SwaggerTest1/api/</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>

</web-app>

根据该指南，这将生成一个 swagger.json 文件，但它在我的项目中不存在。 当我尝试为 swagger.api.basepath 值提供路径时出现问题？ 还是“jersey.config.server.provider.packages”值有问题？

补充。

这是 MyResource.java 类

package com.api;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;



/**
 * Root resource (exposed at "myresource" path)
 */
@Path("/myresource")
public class MyResource {

    /**
     * Method handling HTTP GET requests. The returned object will be sent
     * to the client as "text/plain" media type.
     *
     * @return String that will be returned as a text/plain response.
     */
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String getIt() {
        return "Got it!";
    }
}

Project files

我有几天的时间试图解决这个问题 感谢您的帮助！

Answer 1

更新！

我注意到没有“swagger.json”文件。 Swagger 在编译时创建它 时间。

基于此，我像这样更改了 Swagger Servlet 配置

<servlet>
        <servlet-name>Jersey2Config</servlet-name>
        <servlet-class>io.swagger.jersey.config.JerseyJaxrsConfig</servlet-class>
        <init-param>
            <param-name>api.version</param-name>
            <param-value>1.0</param-value>
        </init-param>
        <init-param>            
            <param-name>swagger.api.basepath</param-name>
            **<param-value>http://localhost:8080/SwaggerTest1/api</param-value>**
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>

在 file.html 中（在 dist 文件夹中） 改变url值如下

$(function () {
      var url = window.location.search.match(/url=([^&]+)/);
      if (url && url.length > 1) {
        url = decodeURIComponent(url[1]);
      } else {
        url = "http://localhost:8080/SwaggerTest1/api/swagger.json";
      }

有了这些改变，我终于用这个 URL 打开了 Swagger

http://localhost:8080/SwaggerTest1/dist