使用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)我在我的Application子类中连接了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,我得到了这个输出.

你可以在这里查看我的公共回购.

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,你会看到

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

这里唯一可以导致NPE的是context,向上滚动会显示它是ServletContext.现在这就是它为空的原因.为了甚至成为 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

^{有关GrizzlyWebContainerFactory其他配置选项,请参阅API .}

现在如果你运行它并再次点击端点,你会看到Swagger JSON.请注意,端点的响应只是JSON,而不是文档界面.为此,您需要使用可以解释JSON的Swagger UI.

感谢MCVE项目BTW.