带有嵌入式 Jetty 的 Swagger

Question

有人可以告诉我这是否是使用嵌入式码头配置 Swagger 的正确方法。

public class TestMain {

public static void main(String[] args) throws Exception {
    Server gs = new Server();
    ServletContextHandler sch = gs.getServletContextHandler();

    sch.addFilter(new FilterHolder(new RequestTrackerFilter()), "/*",     EnumSet.of(DispatcherType.REQUEST));
    sch.addFilter(new FilterHolder(new ActionIdFilter()), "/*", EnumSet.of(DispatcherType.REQUEST));

    ResourceHandler resource_handler = new ResourceHandler();
    resource_handler.setDirectoriesListed(false);

    resource_handler.setResourceBase("public/2.0");

    ContextHandler context = new ContextHandler("/apitest");

    context.setHandler(resource_handler);

    ContextHandlerCollection contexts = new ContextHandlerCollection();


   setupSwaggerContextHandler();

  //     context.getServletContext().addListener(new SwaggerInitializer());

    contexts.setHandlers(new Handler[]{sch, context});

    gs.getServer().setHandler(contexts);

    gs.start();
}

private static ServletContextHandler setupSwaggerContextHandler() {
    // Configure Swagger-core
    final ServletHolder swaggerServletHolder = new ServletHolder(new JerseyJaxrsConfig());
    swaggerServletHolder.setName("JerseyJaxrsConfig");
    swaggerServletHolder.setInitParameter("api.version", "1.0.0");
    swaggerServletHolder.setInitParameter("swagger.api.basepath", "http://localhost:9000/apitest");
    swaggerServletHolder.setInitOrder(2);

    final ServletContextHandler swaggerContextHandler = new ServletContextHandler();
    swaggerContextHandler.setSessionHandler(new SessionHandler());
    // Bind Swagger-core to the url HOST/api-docs
    swaggerContextHandler.setContextPath("/api-docs");
    swaggerContextHandler.addServlet(swaggerServletHolder, "/*");

    return swaggerContextHandler;
  }
}

我无法使用

看到任何输出

  http://localhost:9000/apitest/api-docs

我正在关注https://groups.google.com/forum/#!topic/swagger-swaggersocket/KHYESESD6c4的讨论

Answer 1

为了让 Swagger 与没有 web.xml 或 Spring 的嵌入式 Jetty 一起工作，我做了很多工作，最后得到了这个解决方案： https://github.com/SriramKeerthi/swagger-jersey2-jetty

如果我有足够的声誉，我会添加它作为评论。但这是我能想到的最简单的代码版本。你需要两个部分：

1. Swagger Bean 配置：

   BeanConfig beanConfig = new BeanConfig();
   beanConfig.setVersion("1.0.0");
   beanConfig.setResourcePackage(YourJerseyResourceClass.class.getPackage().getName());
   beanConfig.setScan(true);
   beanConfig.setBasePath("/");
   beanConfig.setDescription("Sample API to demonstrate Swagger with Jersey2" +
           " in an embedded Jetty instance, with no web.xml or Spring MVC.");
   beanConfig.setTitle("Sample API");
   

2. 添加：

   ResourceConfig resourceConfig = new ResourceConfig();
   // Add your resources and Swagger resources (ApiListingResource package)
   resourceConfig.packages(YourJerseyResourceClass.class.getPackage().getName(), ApiListingResource.class.getPackage().getName());
   ServletContainer servletContainer = new ServletContainer(resourceConfig);
   ServletHolder servletHolder = new ServletHolder(servletContainer);
   ServletContextHandler servletContextHandler = new ServletContextHandler(ServletContextHandler.SESSIONS);
   servletContextHandler.setContextPath("/");
   servletContextHandler.addServlet(servletHolder, "/*");
   

您现在应该能够在 /swagger.json 端点看到 Swagger spec。

附： irc.freenode.net 上#swagger 的团队非常出色，如果没有任何问题，您应该访问他们。

Answer 2

如果您使用的是 swagger-core 1.5.x，则需要在上下文路径下查找 /swagger.json。因此对于您的设置：

http://localhost:9000/apitest/api-docs/swagger.json

Answer 3

在找到解决方案之前，我被困了好几个小时。尽管我的配置与 OP 略有不同，但在此处添加它。对于我来说，我只需要几行配置就可以插入我的嵌入式 Jetty 和 RestService

// Jetty configuration

// ContextHandlerCollection contexts

ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS);
context.setContextPath("/api");
context.addFilter(GzipFilter.class, "/*", EnumSet.allOf(DispatcherType.class));

ResourceConfig resourceConfig = new ResourceConfig(ImmutableSet.<Class<?>>builder()
                                                                .add(MyRestService.class)
                                                                .build());
// BELOW LINE WAS THE ONLY THING IN JETTY THAT WAS NEEDED               
resourceConfig.packages( ApiListingResource.class.getPackage().getName() );

context.addServlet(new ServletHolder(new ServletContainer(resourceConfig)), "/*");
contexts.addHandler(context);    

关于其余的服务，我必须补充：

@Api(value = "MyRestService")
public class MyRestService
{
    @ApiOperation(notes = "Get object api", value = "Get objects")
    public Response getObjects() {....}

}

编辑 如果你想配置像basepath这样的swagger属性，你可以使用自包含的BeanConfig进行配置：

BeanConfig beanConfig = new BeanConfig();
        beanConfig.setVersion( "1.0.0" );
        beanConfig.setResourcePackage( SalusRestService.class.getPackage().getName() );
        beanConfig.setScan( true );
        beanConfig.setBasePath( "/api/v1" );
        beanConfig.setDescription( "Entity Browser API to demonstrate Swagger with Jersey2 in an " + "embedded Jetty instance, with no web.xml or Spring MVC." );
        beanConfig.setTitle( "Entity Browser" );