使用 JAX-RS Jersey 2 和 Grizzly 的 Swagger 文档

我已经使用 JAX-RS 实现了 Rest Web 服务（该功能不相关）。现在我想使用 Swagger 生成其文档。我已按照以下步骤操作：

1) In build.gradle我得到了我需要的所有依赖项：

compile 'org.glassfish.jersey.media:jersey-media-moxy:2.13'

2）我用 Swagger 注释来记录我的代码

3）我在我的应用程序子类中连接了 Swagger：

public class ApplicationConfig extends ResourceConfig  {

    /**
     * Main constructor
     * @param addressBook a provided address book
     */
    public ApplicationConfig(final AddressBook addressBook) {
        register(AddressBookService.class);
        register(MOXyJsonProvider.class);
        register(new AbstractBinder() {
            @Override
            protected void configure() {
                bind(addressBook).to(AddressBook.class);
            }
        });
        register(io.swagger.jaxrs.listing.ApiListingResource.class);
        register(io.swagger.jaxrs.listing.SwaggerSerializers.class);

        BeanConfig beanConfig = new BeanConfig();
        beanConfig.setVersion("1.0.2");
        beanConfig.setSchemes(new String[]{"http"});
        beanConfig.setHost("localhost:8282");
        beanConfig.setBasePath("/");
        beanConfig.setResourcePackage("rest.addressbook");
        beanConfig.setScan(true);
    }
}

然而，当去我的服务时http://localhost:8282/swagger.json，我得到这个输出。

你可以查看我的公共仓库here https://github.com/Santi-7/Laboratory-3-Restful-Web-Services.

在这样的时候（当问题没有真正的解释时）我会抛出一个ExceptionMapper<Throwable>。通常，与服务器相关的异常，没有映射器来处理异常，因此它会冒泡到容器中，我们会得到一个无用的 500 状态代码，可能还会收到来自服务器的一些无用的消息（正如您从 Grizzly 中看到的那样）。

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;

public class DebugMapper implements ExceptionMapper<Throwable>  {

    @Override
    public Response toResponse(Throwable exception) {
        exception.printStackTrace();
        if (exception instanceof WebApplicationException) {
            return ((WebApplicationException)exception).getResponse();
        }
        return Response.serverError().entity(exception.getMessage()).build();
    }  
}

然后只需在应用程序中注册即可

public ApplicationConfig(final AddressBook addressBook) {
    ...
    register(DebugMapper.class);
}

当您再次运行应用程序并尝试到达端点时，您现在将看到包含异常原因的堆栈跟踪

java.lang.NullPointerException
  at io.swagger.jaxrs.listing.ApiListingResource.getListingJson(ApiListingResource.java:90)

如果你看一下源代码 https://github.com/swagger-api/swagger-core/blob/v1.5.0/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/listing/ApiListingResource.java#L90 for ApiListingResource.java:90， 你会看见

Swagger swagger = (Swagger) context.getAttribute("swagger");

这里唯一可能导致 NPE 的是context, which 向上滚动 https://github.com/swagger-api/swagger-core/blob/v1.5.0/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/listing/ApiListingResource.java#L42会告诉你这是ServletContext。现在这就是它为空的原因。为了让那里甚至be a ServletContext，应用程序需要在Servlet环境中运行。但看看你的设置：

HttpServer server = GrizzlyHttpServerFactory
        .createHttpServer(uri, new ApplicationConfig(ab));

这不会创建 Servlet 容器。它只创建一个 HTTP 服务器。您具有创建 Servlet 容器所需的依赖项（jersey-container-grizzly2-servlet），但你只需要利用它。因此，您应该执行以下操作，而不是之前的配置

ServletContainer sc = new ServletContainer(new ApplicationConfig(ab));
HttpServer server = GrizzlyWebContainerFactory.create(uri, sc, null, null); 
// you will need to catch IOException or add a throws clause

^{See the API for GrizzlyWebContainerFactory https://jersey.java.net/apidocs/2.8/jersey/org/glassfish/jersey/grizzly2/servlet/GrizzlyWebContainerFactory.html for other configuration options.}

现在，如果您运行它并再次点击端点，您将看到 Swagger JSON。请注意，来自端点的响应只是 JSON，而不是文档接口。为此，您需要使用可以解释 JSON 的 Swagger UI。

感谢您的MCVE https://stackoverflow.com/help/mcve顺便说一句，项目。