Java Code Examples for io.swagger.jaxrs.config.BeanConfig#setDescription()
The following examples show how to use
io.swagger.jaxrs.config.BeanConfig#setDescription() .
You can vote up the ones you like or vote down the ones you don't like,
and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.
Example 1
| Source File: ApiDocConfig.java From ambari-logsearch with Apache License 2.0 | 8 votes |
|
@Bean
public BeanConfig swaggerConfig() {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setSchemes(new String[]{"http", "https"});
beanConfig.setBasePath(BASE_PATH);
beanConfig.setTitle(TITLE);
beanConfig.setDescription(DESCRIPTION);
beanConfig.setLicense(LICENSE);
beanConfig.setLicenseUrl(LICENSE_URL);
beanConfig.setScan(true);
beanConfig.setVersion(VERSION);
beanConfig.setResourcePackage(ServiceLogsResource.class.getPackage().getName());
License license = new License();
license.setName(LICENSE);
license.setUrl(LICENSE_URL);
Info info = new Info();
info.setDescription(DESCRIPTION);
info.setTitle(TITLE);
info.setVersion(VERSION);
info.setLicense(license);
beanConfig.setInfo(info);
return beanConfig;
}
Example 2
| Source File: WebServicesConfiguration.java From microservices-transactions-tcc with Apache License 2.0 | 6 votes |
|
private void configureSwagger() {
// Available at localhost:port/swagger.json
this.register(ApiListingResource.class);
this.register(SwaggerSerializers.class);
BeanConfig config = new BeanConfig();
// config.setConfigId(title);
config.setTitle(title);
config.setDescription(description);
config.setVersion(version);
config.setContact(contact);
config.setSchemes(schemes.split(","));
config.setBasePath(basePath);
config.setResourcePackage(resourcePackage);
config.setPrettyPrint(prettyPrint);
config.setScan(scan);
}
Example 3
| Source File: WebServicesConfiguration.java From microservices-transactions-tcc with Apache License 2.0 | 6 votes |
|
private void configureSwagger() {
// Available at localhost:port/swagger.json
this.register(ApiListingResource.class);
this.register(SwaggerSerializers.class);
BeanConfig config = new BeanConfig();
// config.setConfigId(title);
config.setTitle(title);
config.setDescription(description);
config.setVersion(version);
config.setContact(contact);
config.setSchemes(schemes.split(","));
config.setBasePath(basePath);
config.setResourcePackage(resourcePackage);
config.setPrettyPrint(prettyPrint);
config.setScan(scan);
}
Example 4
| Source File: AdminApiApplication.java From incubator-pinot with Apache License 2.0 | 6 votes |
|
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/");
}
Example 5
| Source File: BrokerAdminApiApplication.java From incubator-pinot with Apache License 2.0 | 6 votes |
|
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/");
}
Example 6
| Source File: ControllerAdminApiApplication.java From incubator-pinot with Apache License 2.0 | 6 votes |
|
private void setupSwagger(HttpServer httpServer, boolean advertiseHttps) {
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 (advertiseHttps) {
beanConfig.setSchemes(new String[]{"https"});
} else {
beanConfig.setSchemes(new String[]{"http"});
}
beanConfig.setBasePath("/");
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/");
}
Example 7
| Source File: EndpointConfig.java From cloudbreak with Apache License 2.0 | 5 votes |
|
private void registerSwagger() throws IOException {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setTitle("Auto-scaling API");
beanConfig.setDescription(FileReaderUtils.readFileFromClasspath("swagger/auto-scaling-introduction"));
beanConfig.setVersion(applicationVersion);
beanConfig.setSchemes(new String[]{"http", "https"});
beanConfig.setBasePath(AutoscaleApi.API_ROOT_CONTEXT);
beanConfig.setLicenseUrl("https://github.com/sequenceiq/cloudbreak/blob/master/LICENSE");
beanConfig.setResourcePackage("com.sequenceiq.periscope.api,com.sequenceiq.authorization");
beanConfig.setScan(true);
beanConfig.setContact("https://hortonworks.com/contact-sales/");
beanConfig.setPrettyPrint(true);
SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, beanConfig);
}
Example 8
| Source File: EndpointConfig.java From cloudbreak with Apache License 2.0 | 5 votes |
|
private void registerSwagger() {
BeanConfig swaggerConfig = new BeanConfig();
swaggerConfig.setTitle("Environment API");
swaggerConfig.setDescription("Environment operation related API.");
swaggerConfig.setVersion(applicationVersion);
swaggerConfig.setSchemes(new String[]{"http", "https"});
swaggerConfig.setBasePath(EnvironmentApi.API_ROOT_CONTEXT);
swaggerConfig.setLicenseUrl("https://github.com/sequenceiq/cloudbreak/blob/master/LICENSE");
swaggerConfig.setResourcePackage("com.sequenceiq.environment.api,com.sequenceiq.flow.api,com.sequenceiq.authorization");
swaggerConfig.setScan(true);
swaggerConfig.setContact("https://hortonworks.com/contact-sales/");
swaggerConfig.setPrettyPrint(true);
SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, swaggerConfig);
}
Example 9
| Source File: EndpointConfig.java From cloudbreak with Apache License 2.0 | 5 votes |
|
@PostConstruct
private void registerSwagger() {
BeanConfig swaggerConfig = new BeanConfig();
swaggerConfig.setTitle("FreeIPA API");
swaggerConfig.setDescription("");
swaggerConfig.setVersion(applicationVersion);
swaggerConfig.setSchemes(new String[]{"http", "https"});
swaggerConfig.setBasePath(FreeIpaApi.API_ROOT_CONTEXT);
swaggerConfig.setLicenseUrl("https://github.com/sequenceiq/cloudbreak/blob/master/LICENSE");
swaggerConfig.setResourcePackage("com.sequenceiq.freeipa.api,com.sequenceiq.flow.api,com.sequenceiq.authorization");
swaggerConfig.setScan(true);
swaggerConfig.setContact("https://hortonworks.com/contact-sales/");
swaggerConfig.setPrettyPrint(true);
SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, swaggerConfig);
}
Example 10
| Source File: EndpointConfig.java From cloudbreak with Apache License 2.0 | 5 votes |
|
@PostConstruct
private void registerSwagger() throws IOException {
BeanConfig swaggerConfig = new BeanConfig();
swaggerConfig.setTitle("Cloudbreak API");
swaggerConfig.setDescription(FileReaderUtils.readFileFromClasspath("swagger/cloudbreak-introduction"));
swaggerConfig.setVersion(cbVersion);
swaggerConfig.setSchemes(new String[]{"http", "https"});
swaggerConfig.setBasePath(CoreApi.API_ROOT_CONTEXT);
swaggerConfig.setLicenseUrl("https://github.com/hortonworks/cloudbreak/blob/master/LICENSE");
swaggerConfig.setResourcePackage("com.sequenceiq.cloudbreak.api,com.sequenceiq.distrox.api,com.sequenceiq.flow.api,com.sequenceiq.authorization");
swaggerConfig.setScan(true);
swaggerConfig.setContact("https://hortonworks.com/contact-sales/");
swaggerConfig.setPrettyPrint(true);
SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, swaggerConfig);
}
Example 11
| Source File: SwaggerConfig.java From cloudbreak with Apache License 2.0 | 5 votes |
|
@PostConstruct
private void registerSwagger() {
BeanConfig swaggerConfig = new BeanConfig();
swaggerConfig.setTitle("Redbeams API");
swaggerConfig.setDescription("API for working with databases and database servers");
swaggerConfig.setVersion(applicationVersion);
swaggerConfig.setSchemes(new String[]{"http", "https"});
swaggerConfig.setBasePath(contextPath + RedbeamsApi.API_ROOT_CONTEXT);
swaggerConfig.setLicenseUrl("https://github.com/sequenceiq/cloudbreak/blob/master/LICENSE");
swaggerConfig.setResourcePackage("com.sequenceiq.redbeams.api,com.sequenceiq.flow.api,com.sequenceiq.authorization");
swaggerConfig.setScan(true);
swaggerConfig.setContact("https://hortonworks.com/contact-sales/");
swaggerConfig.setPrettyPrint(true);
SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, swaggerConfig);
}
Example 12
| Source File: ApiManagerApplication.java From apiman with Apache License 2.0 | 5 votes |
|
/**
* Constructor.
*/
public ApiManagerApplication() {
//add swagger 2.0 config
BeanConfig beanConfig = new BeanConfig();
beanConfig.setVersion(new Version().getVersionString());
beanConfig.setBasePath("/apiman"); //$NON-NLS-1$
beanConfig.setResourcePackage("io.apiman.manager.api.rest"); //$NON-NLS-1$
beanConfig.setTitle("API Manager REST API");
beanConfig.setDescription("The API Manager REST API is used by the API Manager UI to get stuff done. You can use it to automate any API Management task you wish. For example, create new Organizations, Plans, Clients, and APIs.");
beanConfig.setScan(true);
classes.add(SystemResourceImpl.class);
classes.add(SearchResourceImpl.class);
classes.add(RoleResourceImpl.class);
classes.add(UserResourceImpl.class);
classes.add(OrganizationResourceImpl.class);
classes.add(PolicyDefinitionResourceImpl.class);
classes.add(GatewayResourceImpl.class);
classes.add(PluginResourceImpl.class);
classes.add(ActionResourceImpl.class);
classes.add(DownloadResourceImpl.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);
}
Example 13
| Source File: SwaggerParser.java From james-project with Apache License 2.0 | 5 votes |
|
private static BeanConfig getBeanConfig(String packageName, WebAdminConfiguration configuration) {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setResourcePackage(packageName);
beanConfig.setVersion(API_DOC_VERSION);
beanConfig.setTitle(API_DOC_TITLE);
beanConfig.setDescription(API_DOC_DESCRIPTION);
beanConfig.setHost(configuration.getHost() + HOST_PORT_SEPARATOR + configuration.getPort().get().getValue());
beanConfig.setSchemes(SCHEMES);
beanConfig.setScan(true);
beanConfig.scanAndRead();
return beanConfig;
}
Example 14
| Source File: SwaggerActivator.java From ARCHIVE-wildfly-swarm with Apache License 2.0 | 5 votes |
|
@Override
public void activate(ServiceActivatorContext serviceActivatorContext) throws ServiceRegistryException {
InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream(SwaggerArchive.SWAGGER_CONFIGURATION_PATH);
if (in == null) {
// No config available. Print a warning and return
System.err.println("WARN: No swagger configuration found. Swagger not activated.");
return;
}
SwaggerConfig config = new SwaggerConfig(in);
BeanConfig beanConfig = new BeanConfig();
beanConfig.setHost((String) config.get(SwaggerConfig.Key.HOST));
beanConfig.setLicense((String) config.get(SwaggerConfig.Key.LICENSE));
beanConfig.setLicenseUrl((String) config.get(SwaggerConfig.Key.LICENSE_URL));
beanConfig.setTermsOfServiceUrl((String) config.get(SwaggerConfig.Key.TERMS_OF_SERVICE_URL));
beanConfig.setResourcePackage((String) config.get(SwaggerConfig.Key.PACKAGES));
beanConfig.setVersion((String) config.get(SwaggerConfig.Key.VERSION));
beanConfig.setBasePath((String) config.get(SwaggerConfig.Key.ROOT));
beanConfig.setContact((String) config.get(SwaggerConfig.Key.CONTACT));
beanConfig.setDescription((String) config.get(SwaggerConfig.Key.DESCRIPTION));
beanConfig.setTitle((String) config.get(SwaggerConfig.Key.TITLE));
beanConfig.setPrettyPrint((String) config.get(SwaggerConfig.Key.PRETTY_PRINT));
beanConfig.setSchemes((String[]) config.get(SwaggerConfig.Key.SCHEMES));
beanConfig.setScan(true);
}
Example 15
| Source File: ServerModule.java From digdag with Apache License 2.0 | 5 votes |
|
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}");
}
Example 16
| Source File: ServerApplication.java From eagle with Apache License 2.0 | 5 votes |
|
@Override
public void run(ServerConfig configuration, Environment environment) throws Exception {
environment.getApplicationContext().setContextPath(ServerConfig.getContextPath());
environment.jersey().register(RESTExceptionMapper.class);
environment.jersey().setUrlPattern(ServerConfig.getApiBasePath());
environment.getObjectMapper().setFilters(TaggedLogAPIEntity.getFilterProvider());
environment.getObjectMapper().registerModule(new EntityJsonModule());
// Automatically scan all REST resources
new PackagesResourceConfig(ServerConfig.getResourcePackage()).getClasses().forEach(environment.jersey()::register);
// Swagger resources
environment.jersey().register(ApiListingResource.class);
BeanConfig swaggerConfig = new BeanConfig();
swaggerConfig.setTitle(ServerConfig.getServerName());
swaggerConfig.setVersion(ServerConfig.getServerVersion().version);
swaggerConfig.setBasePath(ServerConfig.getApiBasePath());
swaggerConfig.setResourcePackage(ServerConfig.getResourcePackage());
swaggerConfig.setLicense(ServerConfig.getLicense());
swaggerConfig.setLicenseUrl(ServerConfig.getLicenseUrl());
swaggerConfig.setDescription(Version.str());
swaggerConfig.setScan(true);
// Simple CORS filter
environment.servlets().addFilter(SimpleCORSFiler.class.getName(), new SimpleCORSFiler())
.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
// Register authentication provider
BasicAuthBuilder authBuilder = new BasicAuthBuilder(configuration.getAuthConfig(), environment);
environment.jersey().register(authBuilder.getBasicAuthProvider());
if (configuration.getAuthConfig().isEnabled()) {
environment.jersey().getResourceConfig().getResourceFilterFactories()
.add(new BasicAuthResourceFilterFactory(authBuilder.getBasicAuthenticator()));
}
registerAppServices(environment);
}
Example 17
| Source File: SwaggerServletContextListener.java From EDDI with Apache License 2.0 | 5 votes |
|
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);
Swagger swagger = beanConfig.getSwagger();
if ("basic".equals(getConfig("webServer.securityHandlerType"))) {
swagger.securityDefinition("eddi_auth", new BasicAuthDefinition());
} else if ("keycloak".equals(getConfig("webServer.securityHandlerType"))) {
OAuth2Definition oAuth2Definition = new OAuth2Definition()
.implicit(getConfig("swagger.oauth2.implicitAuthorizationUrl"));
oAuth2Definition.setDescription("client_id is 'eddi-engine'");
swagger.securityDefinition("eddi_auth", oAuth2Definition);
}
return beanConfig;
}
Example 18
| Source File: RestApplication.java From microprofile-samples with Apache License 2.0 | 5 votes |
|
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);
}
Example 19
| Source File: SwaggerListener.java From hola with Apache License 2.0 | 5 votes |
|
@Override
public void contextInitialized(ServletContextEvent sce) {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setVersion("1.0.0");
beanConfig.setSchemes(new String[] { "http" });
beanConfig.setTitle("Hola microservices REST API");
beanConfig.setDescription("Operations that can be invoked in the hola microservices");
beanConfig.setResourcePackage("com.redhat.developers.msa.hola");
beanConfig.setLicense("Apache 2.0");
beanConfig.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html");
beanConfig.setContact("[email protected]");
beanConfig.setBasePath("/api");
beanConfig.setPrettyPrint(true);
beanConfig.setScan(true);
}
Example 20
| Source File: SwaggerServiceActivator.java From thorntail with Apache License 2.0 | 4 votes |
|
@Override
public void activate(ServiceActivatorContext serviceActivatorContext) throws ServiceRegistryException {
InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream(SwaggerArchive.SWAGGER_CONFIGURATION_PATH);
if (in == null) {
// try again, we must go deeper.
in = Thread.currentThread().getContextClassLoader().getResourceAsStream("WEB-INF/classes/" + SwaggerArchive.SWAGGER_CONFIGURATION_PATH);
}
if (in == null) {
// No config available. Print a warning and return
SwaggerMessages.MESSAGES.noConfigurationFound();
return;
}
try {
SwaggerConfig config = new SwaggerConfig(in);
BeanConfig beanConfig = new BeanConfig();
beanConfig.setHost((String) config.get(SwaggerConfig.Key.HOST));
beanConfig.setLicense((String) config.get(SwaggerConfig.Key.LICENSE));
beanConfig.setLicenseUrl((String) config.get(SwaggerConfig.Key.LICENSE_URL));
beanConfig.setTermsOfServiceUrl((String) config.get(SwaggerConfig.Key.TERMS_OF_SERVICE_URL));
// some type inconsistencies in the API (String vs String[])
String[] packages = (String[]) config.get(SwaggerConfig.Key.PACKAGES);
if (packages != null) {
StringBuffer sb = new StringBuffer();
for (String s : packages) {
sb.append(s).append(',');
}
beanConfig.setResourcePackage(sb.toString());
}
beanConfig.setVersion((String) config.get(SwaggerConfig.Key.VERSION));
beanConfig.setBasePath((String) config.get(SwaggerConfig.Key.ROOT));
beanConfig.setContact((String) config.get(SwaggerConfig.Key.CONTACT));
beanConfig.setDescription((String) config.get(SwaggerConfig.Key.DESCRIPTION));
beanConfig.setTitle((String) config.get(SwaggerConfig.Key.TITLE));
beanConfig.setPrettyPrint((String) config.get(SwaggerConfig.Key.PRETTY_PRINT));
beanConfig.setSchemes((String[]) config.get(SwaggerConfig.Key.SCHEMES));
beanConfig.setScan(true);
} catch (IOException e) {
throw new ServiceRegistryException(e);
}
}
