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.setSchemes(new String[]{"http", "https"}); 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");
@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 class SwaggerApplication extends HttpServlet { private static final long serialVersionUID = -6039834823506457822L; @Override public void init(ServletConfig config) throws ServletException { super.init(config); BeanConfig beanConfig = new BeanConfig(); final String contextPath = config.getServletContext().getContextPath(); final StringBuilder sbBasePath = new StringBuilder(); sbBasePath.append(contextPath); sbBasePath.append("/rs"); beanConfig.setBasePath(sbBasePath.toString()); // API Info beanConfig.setVersion("0.1"); beanConfig.setTitle("My Swagger APP"); beanConfig.setResourcePackage("your.package.name"); beanConfig.setScan(true); } }
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");
@Override public void contextInitialized(ServletContextEvent sce) { if (SWAGGER_DISABLED) { return; } LOGGER.info("Starting Swagger API discovery"); BeanConfig beanConfig = new BeanConfig(); beanConfig.setBasePath(sce.getServletContext().getContextPath() + "/rest"); if (ControllerUtils.useEmbeddedController()) { //Controller REST endpoints only available when using embedded controller beanConfig.setResourcePackage("org.kie.server.controller.rest"); } beanConfig.setVersion("7.0"); beanConfig.setTitle("Business Central API"); beanConfig.setPrettyPrint(true); beanConfig.setScan(); }
protected void enableSwagger(ApplicationBindingBuilder builder) { BeanConfig beanConfig = new BeanConfig(); beanConfig.setTitle("Digdag"); beanConfig.setDescription("Digdag server API"); beanConfig.setVersion(DigdagVersion.buildVersion().toString()); beanConfig.setResourcePackage(VersionResource.class.getPackage().getName()); beanConfig.setScan(); builder.addProvider(SwaggerSerializers.class) .addProvider(CorsFilter.class) .addResources(SwaggerApiListingResource.class); logger.info("swagger api enabled on: /api/swagger.{json,yaml}"); }
public void apireaderv2() { // tag::apireaderv2[] BeanConfig configuration = new BeanConfig(); configuration.setTitle("The title"); configuration.setVersion("1"); ApiReader<Swagger> reader = SwaggerV2.reader(configuration); // <1> Swagger api = reader.read(ApiEndpoint1.class, ApiEndpoint2.class); // <2> String json = SwaggerV2.asJson(api); // <3> String yaml = SwaggerV2.asYaml(api); // <4> // end::apireaderv2[] }
@Override protected void configure() { if (!isWebServerAutoBindingEnabled()) { return; } LOGGER.info("Registering documentation API via Swagger"); // Automatically register Swagger API documentation endpoints getConfigurable().register(AcceptHeaderApiListingResource.class); getConfigurable().register(SwaggerSerializers.class); // Automatically create and register a Swagger scanner final BeanConfig swaggerConfig = new BeanConfig(); swaggerConfig.setResourcePackage(Joiner.on(',').join(getServiceScan().getServicePackages())); swaggerConfig.setTitle(getApplicationName() + " API"); // Turn on automatic scanning. This should be the last value set in the config. swaggerConfig.setScan(); } }
private void configureSwagger(Environment environment) { BeanConfig config = new BeanConfig(); config.setTitle("Inventory Item API"); config.setVersion("1.0.0"); config.setResourcePackage(InventoryItemResource.class.getPackage().getName()); config.setScan(true); FilterRegistration.Dynamic filter = environment.servlets().addFilter("CORSFilter", CrossOriginFilter.class); filter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, environment.getApplicationContext().getContextPath() + "swagger.json"); filter.setInitParameter(ALLOWED_METHODS_PARAM, "GET,OPTIONS"); filter.setInitParameter(ALLOWED_HEADERS_PARAM, "Origin, Content-Type, Accept"); filter.setInitParameter(ALLOWED_ORIGINS_PARAM, "*"); filter.setInitParameter(ALLOW_CREDENTIALS_PARAM, "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); }
... ApplicationConfig.initializeSwaggerConfiguration(); // call from app config ... /* Swagger configuratoin */ @PostConstruct public static void initializeSwaggerConfiguration() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setSchemes(new String[] { "http" }); String host = PropertyHandler.getInstance().getValue(PARAM_API_HOST) + ":" + PropertyHandler.getInstance().getValue(PARAM_PORT); beanConfig.setHost(host); beanConfig.setBasePath(PropertyHandler.getInstance().getValue(PARAM_API_BASEPATH)); beanConfig.setVersion(PropertyHandler.getInstance().getValue(PARAM_VERSION) + " Profile: " + App.getProfile()); beanConfig.setTitle("SOD Services"); beanConfig.setDescription("Services for handlign the be"); beanConfig.setResourcePackage(SERVICES_PACKAGE); beanConfig.setScan(true); Json.mapper().setPropertyNamingStrategy(PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES); }
/*** * 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); }
private void evaluateSwagger() throws Exception { if (!runPerServiceMode(swagger)) { return; } // Add swagger providers _environment.jersey().register(io.swagger.jaxrs.listing.ApiListingResource.class); _environment.jersey().register(io.swagger.jaxrs.listing.SwaggerSerializers.class); // Configure and initialize swagger BeanConfig beanConfig = new BeanConfig(); beanConfig.setVersion("1.0"); beanConfig.setTitle("EMO REST Resources"); beanConfig.setSchemes(new String[] {"http"}); beanConfig.setHost("localhost:8080"); beanConfig.setBasePath("/"); // add the packages that swagger should scan to pick up the resources beanConfig.setResourcePackage("com.bazaarvoice.emodb.web.resources"); // this is a MUST and should be the last property - this creates a new SwaggerContextService and initialize the scanner. beanConfig.setScan(true); }
private BeanConfig getBeanConfig() { BeanConfig beanConfig = new BeanConfig(); beanConfig.setHost(getConfig("swagger.host")); beanConfig.setSchemes(getConfig("swagger.schemes").split(",")); beanConfig.setTitle(getConfig("swagger.title")); beanConfig.setVersion(getConfig("swagger.version")); beanConfig.setContact(getConfig("swagger.contact")); beanConfig.setLicense(getConfig("swagger.license")); beanConfig.setBasePath(getConfig("swagger.base_path")); beanConfig.setLicenseUrl(getConfig("swagger.licenseUrl")); beanConfig.setDescription(getConfig("swagger.description")); beanConfig.setPrettyPrint(getConfig("swagger.pretty_print")); beanConfig.setTermsOfServiceUrl(getConfig("swagger.terms_of_service_url")); // Must be called last beanConfig.setResourcePackage(resourcePackages()); beanConfig.setScan(true); return beanConfig; }