Impossibile configurare Swagger con il molo incorporato a livello di codice

Question

Ho cercato di usare lo swagger per documentare il servizio jaxrs-resteasy. Voglio configurarlo a livello di codice in un'impostazione del server jetty incorporato. Ecco le mie classi di risorse, server e applicazioni. Posso accedere a http://127.0.0.1:9091/rest/hello e verificare che il mio servizio di assistenza funzioni ... ma quando provo ad accedere a http://127.0.0.1:9091/rest/api-docs non riesco a farlo funzionare, ma vedo un 404 non trovato. Qualcuno può indicarmi cosa potrei fare male durante la configurazione di Swagger.

file di risorse

@Api(value = "/", description = "Index") 
@Path("/") 
public class Index { 

    @GET 
    @ApiOperation(
       value = "call Index", 
       response = Response.class, 
       responseContainer = "Object" 
      ) 
    @Produces("text/html") 
    public Response index() throws URISyntaxException { 
     File f = new File(System.getProperty("user.dir")+"/index.html"); 
     String mt = new MimetypesFileTypeMap().getContentType(f); 
     return Response.ok(f, mt).build(); 
    } 

    @GET 
    @Path("/hello") 
    @ApiOperation(
       value = "hello Get", 
       response = Response.class, 
       responseContainer = "Object" 
      ) 
    public Response helloGet() {  
     return Response.status(200).entity("HTTP GET method called").build(); 
    } 

} 

Server

public class JettyServer { 

    public static void main(String[] args) throws IOException { 

     Server server = new Server(9091); 
     final HandlerList handlers = new HandlerList(); 

     ServletHolder h = new ServletHolder(new HttpServletDispatcher()); 
     h.setInitParameter("javax.ws.rs.Application", "com.all.MyServices"); 

//  h.setInitOrder(1); 

     ServletContextHandler restContextHandler = new ServletContextHandler(ServletContextHandler.SESSIONS); 
     restContextHandler.setContextPath("/rest"); 
     restContextHandler.addServlet(h, "/*"); 

     handlers.addHandler(restContextHandler); 

     server.setHandler(handlers); 

     try { 
      server.start(); 
      server.join(); 
     } catch (Exception e) { 
      e.printStackTrace(); 
     } 

    } 
} 

file di Servizio

public class MyServices extends Application { 

    private static Set<Index> services = new HashSet<>(); 

    public MyServices() {  

     System.out.println("Initializing Swagger BeanConfig"); 
     BeanConfig beanConfig = new BeanConfig(); 
     beanConfig.setVersion("1.0"); 
     beanConfig.setResourcePackage(Index.class.getPackage().getName()); 
     beanConfig.setBasePath("http://localhost:9091/api"); 
     beanConfig.setDescription("My RESTful services"); 
     beanConfig.setTitle("My RESTful API"); 
     beanConfig.setScan(true); 

     services.add(new Index()); 
    } 

    @SuppressWarnings({ "unchecked", "rawtypes" }) 
    @Override 
    public Set getSingletons() { 
     return services; 
    } 

    @SuppressWarnings("rawtypes") 
    public static Set getServices() { 
     return services; 
    } 
} 

Answer 1

So che questa è una vecchia questione, ma questo può aiutare qualcuno, quindi ecco qui.

Non sono sicuro di quali versioni di quello che stai usando, ma questo corrisponde a un problema che ho riscontrato più volte con diverse versioni di Swagger. Una cosa che sto notando è che da nessuna parte stai registrando le classi ApiListingResourceJSON, ApiDeclarationProvider o ResourceListingProvider fornite con Swagger. Queste classi sono necessarie per fornire la risorsa /api-docs/.

Inoltre, la configurazione tipica non ha funzionato per me. L'utilizzo di BeanConfig ha prodotto solo un elemento JSON Swagger vuoto. Se ciò accade, ho risolto questo problema creando una configurazione personalizzata.

public class CustomSwaggerConfig extends HttpServlet { 
    public static final String PACKAGE = "com.shorecg.eureka"; 

    @Override 
    public void init(ServletConfig servletConfig) throws ServletException { 
     super.init(servletConfig); 
     ConfigFactory.setConfig(new WebXMLReader(servletConfig)); 
     ReflectiveJaxrsScanner scanner = new ReflectiveJaxrsScanner(); 
     scanner.setResourcePackage(PACKAGE); 
     ScannerFactory.setScanner(scanner); 
     ClassReaders.setReader(new DefaultJaxrsApiReader()); 
    } 

    class ReflectiveJaxrsScanner implements JaxrsScanner { 
     private String resourcePackage; 

     public String getResourcePackage() { 
      return resourcePackage; 
     } 

     public ReflectiveJaxrsScanner setResourcePackage(String resourcePackage) { 
      this.resourcePackage = resourcePackage; 
      return this; 
     } 

     @Override 
     public List<Class<?>> classes() { 
      Reflections reflections = new Reflections(resourcePackage); 
      Set<Class<?>> clsses = reflections.getTypesAnnotatedWith(Api.class); 
      return JavaConversions.asScalaSet(clsses).toList(); 
     } 

     @Override 
     public List<Class<?>> classesFromContext(Application aplctn, ServletConfig sc) { 
      return classes(); 
     } 

    } 
} 

Questa non è una soluzione perfetta. Ad esempio, se si dispone di risorse che non sono registrate, verranno comunque visualizzate in Swagger se si utilizza questa configurazione di swagger personalizzata. Tuttavia, mi ha fatto capire che la spavalderia funzionava davvero. Spero che questo ti aiuti.