Swagger 配置 - 访问 swagger.json 时出现 404答案

【问题标题】：Swagger configuration - 404 when accessing swagger.jsonSwagger 配置 - 访问 swagger.json 时出现 404
【发布时间】：2023-03-23 06:42:01
【问题描述】：

我是 swagger 的新手，希望在我最新的 REST API 项目中设置它，但失败得很惨。一切似乎都配置正确，但如果没有 404，我无法导航到 swagger.json。我看不到丢失或错误的内容

pom.xml

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

        <exclusions>
            <exclusion>
                <artifactId>jersey-server</artifactId>
                <groupId>com.sun.jersey</groupId>
            </exclusion>
            <exclusion>
                <artifactId>jersey-multipart</artifactId>
                <groupId>com.sun.jersey.contribs</groupId>
            </exclusion>
        </exclusions>
    </dependency>

    <dependency>
        <groupId>com.sun.jersey.contribs</groupId>
        <artifactId>jersey-multipart</artifactId>
        <version>1.11.1</version>
    </dependency>

    <dependency>
        <groupId>com.sun.jersey</groupId>
        <artifactId>jersey-server</artifactId>
        <version>1.11.1</version>
    </dependency>

项目使用 1.11.1 版本的排除，如果从 swagger 导入 1.13 会导致冲突

web.xml

<servlet>
    <servlet-name>Jersey REST Service</servlet-name>
    <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>

    <init-param>
        <param-name>com.sun.jersey.config.property.packages</param-name>
        <param-value>
            io.swagger.jaxrs.json,
            io.swagger.jaxrs.listing,
            uk.package.test.myproject
        </param-value>
    </init-param>       
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet>
    <servlet-name>Jersey2Config</servlet-name>
    <servlet-class>io.swagger.jaxrs.config.DefaultJaxrsConfig</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:8082/myproject/api</param-value>
    </init-param>
    <load-on-startup>2</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>Jersey REST Service</servlet-name>
    <url-pattern>/api/*</url-pattern>
</servlet-mapping>

示例注释...

@ManagedBean
@Path("secure/cache")
@Restrict("ManageCache")
@Api(value = "secure/cache", description = "Rest api for do operations on     admin", produces = MediaType.APPLICATION_JSON)
public class AdminApi {....


@GET
@Path("{name}")
@Produces(MediaType.APPLICATION_JSON)

@ApiOperation(value = "Get specific admin", httpMethod = "GET", notes = "Fetch the admin user details", response = Response.class)
@ApiResponses(value = { @ApiResponse(code = 200, message = "Given admin user found"),
    @ApiResponse(code = 404, message = "Given admin user not found"),
    @ApiResponse(code = 500, message = "Internal server error due to encoding the data"),
    @ApiResponse(code = 400, message = "Bad request due to decoding the data"),
    @ApiResponse(code = 412, message = "Pre condition failed due to required data not found") })

public List<String> getCacheKeys(.....

当项目运行时，会记录以下内容...

10:46:48,724 INFO  [com.sun.jersey.api.core.PackagesResourceConfig] (MSC service thread 1-5) Scanning for root resource and provider classes in the packages:
  io.swagger.jaxrs.json
  io.swagger.jaxrs.listing
  uk.package.test.myproject
10:46:48,771 INFO  [com.sun.jersey.api.core.ScanningResourceConfig] (MSC service thread 1-5) Root resource classes found:
  class uk.package.test.myproject.api.NotificationApi
  class uk.package.test.myproject.api.UserApi
  class uk.package.test.myproject.api.FlagsApi
  class uk.package.test.myproject.api.UnitsByFunctionApi
  class uk.package.test.myproject.api.CvDataApi
  class uk.package.test.myproject.api.ImageApi
  class uk.package.test.myproject.api.GazetteerApi
  class uk.package.test.myproject.api.SearchApi
  class uk.package.test.myproject.api.ViewApi
  class uk.package.test.myproject.api.AdminApi
10:46:48,776 INFO  [com.sun.jersey.api.core.ScanningResourceConfig] (MSC service thread 1-5) No provider classes found.
10:46:48,834 INFO  [com.sun.jersey.server.impl.cdi.CDIComponentProviderFactoryInitializer] (MSC service thread 1-5) CDI support is enabled
10:46:48,842 INFO  [com.sun.jersey.server.impl.application.WebApplicationImpl] (MSC service thread 1-5) Initiating Jersey application, version 'Jersey: 1.11.1 03/31/2012 06:49 PM'

提前谢谢你

干杯

马丁

【问题讨论】：

标签： java json rest maven swagger

【解决方案1】：

只是为了让您知道我已经通过使用自定义应用程序而不是使用包扫描解决了这个问题:)

感谢您的帮助

马丁

【讨论】：

你能分享你的解决方案吗？因为我也在使用自定义 Application（来自我的 Jersey 配置），但我在任何地方都看不到文档或任何错误。

【解决方案2】：

您的 servlet 映射表明您不应该查看您指定的路径：

<servlet-mapping>
    <servlet-name>Jersey REST Service</servlet-name>
    <url-pattern>/api/*</url-pattern>
</servlet-mapping>

这通常意味着查看 /api 路径。这意味着，除非您使用名为 myproject 的 webapp，否则您应该查看 /api/swagger.json

【讨论】：