private void setupSwagger() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Pinot Broker API"); beanConfig.setDescription("APIs for accessing Pinot broker information"); beanConfig.setContact("https://github.com/apache/incubator-pinot"); beanConfig.setVersion("1.0"); beanConfig.setSchemes(new String[]{"http"}); beanConfig.setBasePath(_baseUri.getPath()); beanConfig.setResourcePackage(RESOURCE_PACKAGE); beanConfig.setScan(true); HttpHandler httpHandler = new CLStaticHttpHandler(BrokerAdminApiApplication.class.getClassLoader(), "/api/"); // map both /api and /help to swagger docs. /api because it looks nice. /help for backward compatibility _httpServer.getServerConfiguration().addHttpHandler(httpHandler, "/api/", "/help/"); URL swaggerDistLocation = BrokerAdminApiApplication.class.getClassLoader().getResource("META-INF/resources/webjars/swagger-ui/2.2.2/"); CLStaticHttpHandler swaggerDist = new CLStaticHttpHandler(new URLClassLoader(new URL[]{swaggerDistLocation})); _httpServer.getServerConfiguration().addHttpHandler(swaggerDist, "/swaggerui-dist/"); }
private void setupSwagger(HttpServer httpServer) { BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Pinot Server API"); beanConfig.setDescription("APIs for accessing Pinot server information"); beanConfig.setContact("https://github.com/apache/incubator-pinot"); beanConfig.setVersion("1.0"); beanConfig.setSchemes(new String[]{"http"}); beanConfig.setBasePath(baseUri.getPath()); beanConfig.setResourcePackage(RESOURCE_PACKAGE); beanConfig.setScan(true); CLStaticHttpHandler staticHttpHandler = new CLStaticHttpHandler(AdminApiApplication.class.getClassLoader(), "/api/"); // map both /api and /help to swagger docs. /api because it looks nice. /help for backward compatibility httpServer.getServerConfiguration().addHttpHandler(staticHttpHandler, "/api/"); httpServer.getServerConfiguration().addHttpHandler(staticHttpHandler, "/help/"); URL swaggerDistLocation = AdminApiApplication.class.getClassLoader().getResource("META-INF/resources/webjars/swagger-ui/2.2.2/"); CLStaticHttpHandler swaggerDist = new CLStaticHttpHandler(new URLClassLoader(new URL[]{swaggerDistLocation})); httpServer.getServerConfiguration().addHttpHandler(swaggerDist, "/swaggerui-dist/"); }
private void setupSwagger(HttpServer httpServer) { BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Pinot Controller API"); beanConfig.setDescription("APIs for accessing Pinot Controller information"); beanConfig.setContact("https://github.com/apache/incubator-pinot"); beanConfig.setVersion("1.0"); if (_useHttps) { beanConfig.setSchemes(new String[]{"https"}); } else { beanConfig.setSchemes(new String[]{"http"}); } beanConfig.setBasePath(baseUri.getPath()); beanConfig.setResourcePackage(RESOURCE_PACKAGE); beanConfig.setScan(true); ClassLoader loader = this.getClass().getClassLoader(); CLStaticHttpHandler apiStaticHttpHandler = new CLStaticHttpHandler(loader, "/api/"); // map both /api and /help to swagger docs. /api because it looks nice. /help for backward compatibility httpServer.getServerConfiguration().addHttpHandler(apiStaticHttpHandler, "/api/"); httpServer.getServerConfiguration().addHttpHandler(apiStaticHttpHandler, "/help/"); URL swaggerDistLocation = loader.getResource("META-INF/resources/webjars/swagger-ui/2.2.2/"); CLStaticHttpHandler swaggerDist = new CLStaticHttpHandler(new URLClassLoader(new URL[]{swaggerDistLocation})); httpServer.getServerConfiguration().addHttpHandler(swaggerDist, "/swaggerui-dist/"); }
beanConfig.setDescription("<a href='https://github.com/scouter-project/scouter/blob/master/scouter.document/tech/Web-API-Guide.md' target='_blank'> [Scouter document page] Scouter Web API Guide</a>"); beanConfig.setTitle("Scouter HTTP APIs"); beanConfig.setBasePath("/scouter"); beanConfig.setResourcePackage("scouterx.webapp"); beanConfig.setFilterClass(this.filterClass);
@Component @ApplicationPath("/api") public static class JerseyConfig extends ResourceConfig { public JerseyConfig() { BeanConfig swaggerConfig = new BeanConfig(); swaggerConfig.setBasePath("/api"); SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, swaggerConfig); packages(getClass().getPackage().getName(), ApiListingResource.class.getPackage().getName()); } }
/** * Constructor. */ public GatewayMicroServiceApplication() { //add swagger 2.0 config BeanConfig beanConfig = new BeanConfig(); beanConfig.setBasePath("/api"); //$NON-NLS-1$ beanConfig.setResourcePackage("io.apiman.gateway.api.rest.contract"); //$NON-NLS-1$ //TODO set more info in the beanConfig (title,description, version, etc) beanConfig.setScan(true); classes.add(SystemResourceImpl.class); classes.add(ApiResourceImpl.class); classes.add(ClientResourceImpl.class); classes.add(OrgResourceImpl.class); //add swagger 2.0 resource classes.add(io.swagger.jaxrs.listing.ApiListingResource.class); classes.add(io.swagger.jaxrs.listing.SwaggerSerializers.class); classes.add(RestExceptionMapper.class); }
@Bean @Lazy(false) public BeanConfig swaggerConfig(@Value("${server.context-path}") String contextPath, @Value("${build.version}") String buildVersion) { String basePath = contextPath.equals("/") ? JerseyConfig.REST_PATH : contextPath + JerseyConfig.REST_PATH; BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Device Hive REST API"); beanConfig.setVersion(buildVersion); beanConfig.setBasePath(basePath); beanConfig.setResourcePackage("com.devicehive.resource"); beanConfig.setScan(true); return beanConfig; }
@Bean @Lazy(false) public BeanConfig swaggerConfig(@Value("${server.context-path}") String contextPath, @Value("${build.version}") String buildVersion) { String basePath = contextPath.equals("/") ? JerseyConfig.REST_PATH : contextPath + JerseyConfig.REST_PATH; BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Device Hive REST API"); beanConfig.setVersion(buildVersion); beanConfig.setBasePath(basePath); beanConfig.setResourcePackage("com.devicehive.resource"); beanConfig.setScan(true); return beanConfig; }
@Bean @Lazy(false) public BeanConfig swaggerConfig(@Value("${server.context-path}") String contextPath, @Value("${build.version}") String buildVersion) { String basePath = contextPath.equals("/") ? JerseyConfig.REST_PATH : contextPath + JerseyConfig.REST_PATH; BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Device Hive REST API"); beanConfig.setVersion(buildVersion); beanConfig.setBasePath(basePath); beanConfig.setResourcePackage("com.devicehive.resource"); beanConfig.setScan(true); return beanConfig; }
public V1Application() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setVersion("v1"); beanConfig.setTitle("Syndesis Rest API"); beanConfig.setSchemes(new String[]{"http", "https"}); beanConfig.setBasePath("/api/v1"); beanConfig.setResourcePackage(getClass().getPackage().getName()); beanConfig.setScan(true); }
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");
public AppStorageApplication() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setBasePath("/rest"); beanConfig.setResourcePackage(AppStorageServer.class.getPackage().getName()); beanConfig.setScan(); beanConfig.setInfo(new Info() .title("AFS storage API") .version(AfsRestApi.VERSION) .description("This is the documentation of AFS storage REST API")); } }
private void bindSwagger() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setBasePath("/"); beanConfig.setResourcePackage(API_PACKAGE); beanConfig.setScan(true); SwaggerModelTransformer transformer = SwaggerModelTransformer.builder() .addTransformation(new ResultContainerTransformation(ResultStash.class, "data")) .build(); bind(SwaggerApiListingResource.class).in(Scopes.SINGLETON); bind(SwaggerSerializers.class).in(Scopes.SINGLETON); bind(SwaggerModelTransformer.class).toInstance(transformer); }
@Component @ApplicationPath(Pathes.APPLICATION_PATH) public class JerseyConfig extends ResourceConfig { @Autowired public JerseyConfig(@Value("${server.port}") int port) { final BeanConfig beanConfig = new BeanConfig(); beanConfig.setVersion("1.0.0"); beanConfig.setHost("localhost:" + port); beanConfig.setBasePath(Pathes.APPLICATION_PATH); beanConfig.setResourcePackage(myPackages); beanConfig.setScan(true); register(ApiListingResource.class); register(SwaggerSerializers.class); } }
register(ApiListingResource.class); register(SwaggerSerializers.class); BeanConfig beanConfig = new BeanConfig(); beanConfig.setVersion("1.0.0"); beanConfig.setSchemes(new String[]{"http"}); beanConfig.setBasePath("/api"); //or insert your base path (see main Jersey app class) beanConfig.setResourcePackage("com.xxx.where.your.endpoints"); beanConfig.setScan(true); beanConfig.setPrettyPrint(true);
@ApplicationPath("/api") public class MyApplication extends Application { public MyApplication() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setVersion("1.0"); beanConfig.setSchemes(new String[]{"http"}); beanConfig.setHost("localhost:8080"); beanConfig.setBasePath("/api"); beanConfig.setResourcePackage("io.swagger.resources,com.example.project"); beanConfig.setScan(true); } }
public class SampleApplication extends Application { public SampleApplication() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setVersion("1.0.2"); beanConfig.setSchemes(new String[]{"http"}); beanConfig.setHost("localhost:8002"); beanConfig.setBasePath("/api"); beanConfig.setResourcePackage("io.swagger.resources"); beanConfig.setScan(true); } @Override public Set<Class<?>> getClasses() { // set your resources here } }
/** * When the container starts up, extract the required context parameters * and run the scanner. * * @param container The container. */ @Override public void onStartup(final Container container) { String name = context.getServletContextName(); ServletRegistration registration = context.getServletRegistration(name); String scannerId = registration.getInitParameter("swagger.context.id"); String basePath = context.getContextPath(); BeanConfig beanConfig = new BeanConfig(); beanConfig.setResourcePackage(classPath); beanConfig.setScannerId(scannerId); beanConfig.setBasePath(basePath); beanConfig.setUsePathBasedConfig(true); beanConfig.setScan(true); }
public RestApplication() { final BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("TOP CDs"); beanConfig.setDescription("Gives the TOP selling CDs"); beanConfig.setVersion("1.0.0"); beanConfig.setSchemes(new String[] { "http" }); beanConfig.setHost("localhost:8080/msTopCDs"); beanConfig.setBasePath("/"); beanConfig.setResourcePackage("org.eclipse.microprofile.sample.swagger.rest"); beanConfig.setPrettyPrint(true); beanConfig.setScan(true); }
/*** * The context path must be set before configuring swagger * @param environment */ void configureSwagger(Environment environment, String basePath) { environment.jersey().register(new ApiListingResource()); environment.jersey().register(new SwaggerJsonBareService()); environment.jersey().register(new SwaggerSerializers()); ScannerFactory.setScanner(new DefaultJaxrsScanner()); environment.getObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL); BeanConfig config = new BeanConfig(); // api specific configuration config.setTitle("SciGraph"); config.setVersion("1.0.1"); config.setResourcePackage("io.scigraph.services.resources"); config.setScan(true); // TODO: Fix this so the swagger client generator can work correctly config.setBasePath("/" + basePath); }