JAX-RS Jersey 2 和 Grizzly 的 Swagger 文档

Question

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

1) 在 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 进行服务时，我得到了这个输出。

您可以查看我的 public 存储库 here。

Answer 1

像这样的时候（当对问题没有真正的解释时）我会抛出一个 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)

如果您查看 ApiListingResource.java:90 的 source code，您将看到

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

此处唯一可能导致 NPE 的是 context，scrolling up 将向您显示它是 ServletContext。这就是它为空的原因。为了甚至成为和 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

^{有关其他配置选项，请参阅 API for GrizzlyWebContainerFactory。}

现在，如果您运行它并再次到达终点，您将看到 Swagger JSON。请注意端点的响应只是 JSON，它不是文档界面。为此，您需要使用可以解释 JSON.

的 Swagger UI

感谢 MCVE 项目顺便说一句。

Answer 2

Swagger 在 1.5.7 中修复了这个问题。它是 Issue 1103，但修复是在去年 2 月推出的。 peeskillet 的答案仍然有效，但现在 OP 也将有效。

JAX-RS Jersey 2 和 Grizzly 的 Swagger 文档

Swagger documentation with JAX-RS Jersey 2 and Grizzly

rest

jax-rs

grizzly

swagger

jersey-2.0