本文整理汇总了Java中io.swagger.jaxrs.config.BeanConfig.setDescription方法的典型用法代码示例。如果您正苦于以下问题:Java BeanConfig.setDescription方法的具体用法?Java BeanConfig.setDescription怎么用?Java BeanConfig.setDescription使用的例子?那么, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类io.swagger.jaxrs.config.BeanConfig
的用法示例。
在下文中一共展示了BeanConfig.setDescription方法的15个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于系统推荐出更棒的Java代码示例。
示例1: activate
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
@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);
}
示例2: swaggerConfig
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
@Bean
public BeanConfig swaggerConfig() {
final BeanConfig beanConfig = new BeanConfig();
beanConfig.setResourcePackage("com.github.sbugat.samplerest.resource");
beanConfig.setVersion("1.0.0");
beanConfig.setHost("localhost:8080");
beanConfig.setBasePath(servletContext.getContextPath());
beanConfig.setTitle("Swagger CXF, JAX-RS 2.0 sample");
beanConfig.setDescription("This is a Swagger CXF, JAX-RS 2.0 sample API.");
beanConfig.setContact("Sylvain Bugat");
beanConfig.setLicense("Apache 2.0");
beanConfig.setLicenseUrl("https://github.com/Sylvain-Bugat/swagger-cxf-rest-skeleton/blob/master/LICENSE");
beanConfig.getSwagger().addSecurityDefinition("api_token", new ApiKeyAuthDefinition("api_token", In.HEADER));
beanConfig.setScan(true);
return beanConfig;
}
示例3: RESTConfig
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
public RESTConfig() {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setVersion(STORR_API_VERSION);
beanConfig.setSchemes(new String[]{"http"});
beanConfig.setBasePath("/");
beanConfig.setResourcePackage(REST_PACKAGE);
beanConfig.setTitle("storr API");
beanConfig.setDescription("This REST API exposes the basic functions of storr. " +
"storr is a NoSQL store intended to provide easy storage of arbitrary tuples");
beanConfig.setScan(true);
beanConfig.setPrettyPrint(true);
packages(REST_PACKAGE);
register(LoggingFeature.class);
register(ApiListingResource.class);
register(SwaggerSerializers.class);
}
示例4: configureSwagger
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
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);
}
示例5: getBeanConfig
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
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;
}
示例6: init
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
@Override
public void init(ServletConfig config) throws ServletException {
super.init(config);
ConfigureAdaptor scouterConf = ConfigureManager.getConfigure();
if (!scouterConf.isNetHttpApiSwaggerEnabled()) {
return;
}
BeanConfig beanConfig = new BeanConfig();
String serverIp = scouterConf.getNetHttpApiSwaggerHostIp();
if (StringUtils.isNotBlank(serverIp)) {
beanConfig.setHost(serverIp + ":" + String.valueOf(scouterConf.getNetHttpPort()));
}
beanConfig.setVersion(this.apiVersion);
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");
beanConfig.setFilterClass(this.filterClass);
beanConfig.setScan(true);
}
示例7: bildSwaggerConfig
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
private void bildSwaggerConfig() {
BeanConfig beanConfig = new BeanConfig();
//beanConfig.setConfigId("configId: " + contextId++);
beanConfig.setTitle("Bagri REST server");
beanConfig.setDescription("goto http://bagridb.com for more info");
beanConfig.setContact("[email protected]");
beanConfig.setLicense("Apache 2.0");
beanConfig.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html");
beanConfig.setVersion(bg_version);
beanConfig.setSchemes(new String[] {"http", "https"});
// TODO: get host info somehow..
beanConfig.setHost("localhost:" + port);
beanConfig.setBasePath("/"); // /api
beanConfig.setResourcePackage("com.bagri.rest.service");
beanConfig.setPrettyPrint(true);
// force Swagger to re-scan the package mentioned above and use
// custom ReaderListener from that package
beanConfig.setScan(true);
}
示例8: setupSwagger
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
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/linkedin/pinot");
beanConfig.setVersion("1.0");
beanConfig.setSchemes(new String[]{"http"});
beanConfig.setBasePath(baseUri.getPath());
beanConfig.setResourcePackage(RESOURCE_PACKAGE);
beanConfig.setScan(true);
CLStaticHttpHandler apiStaticHttpHandler = new CLStaticHttpHandler(ControllerAdminApiApplication.class.getClassLoader(),
"/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 = ControllerAdminApiApplication.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/");
}
示例9: setupSwagger
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
private void setupSwagger(HttpServer httpServer) {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setTitle("Pinot Broker API");
beanConfig.setDescription("APIs for accessing Pinot broker information");
beanConfig.setContact("https://github.com/linkedin/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(BrokerAdminApiApplication.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 =
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/");
}
示例10: setupSwagger
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
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/linkedin/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/");
}
示例11: registerSwagger
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
@PostConstruct
private void registerSwagger() throws IOException {
BeanConfig swaggerConfig = new BeanConfig();
swaggerConfig.setTitle("Cloudbreak API");
swaggerConfig.setDescription(FileReaderUtils.readFileFromClasspath("swagger/cloudbreak-introduction"));
if (Strings.isNullOrEmpty(cbVersion)) {
swaggerConfig.setVersion(VERSION_UNAVAILABLE);
} else {
swaggerConfig.setVersion(cbVersion);
}
swaggerConfig.setSchemes(new String[]{"http", "https"});
swaggerConfig.setBasePath(CoreApi.API_ROOT_CONTEXT);
swaggerConfig.setLicenseUrl("https://github.com/sequenceiq/cloudbreak/blob/master/LICENSE");
swaggerConfig.setResourcePackage("com.sequenceiq.cloudbreak.api");
swaggerConfig.setScan(true);
swaggerConfig.setContact("https://hortonworks.com/contact-sales/");
swaggerConfig.setPrettyPrint(true);
SwaggerConfigLocator.getInstance().putConfig(SwaggerContextService.CONFIG_ID_DEFAULT, swaggerConfig);
}
示例12: setUpSwagger
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
private void setUpSwagger() {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setTitle("Sample Jersey 2.x RESTful Web Application");
beanConfig.setDescription(
"Sample Jersey 2.x Web Application that can be deployed in a Servlet Container"
);
beanConfig.setLicense("Unlicense");
beanConfig.setLicenseUrl("http://unlicense.org");
beanConfig.setVersion("1.0.0");
beanConfig.setSchemes(new String[]{"http"});
beanConfig.setBasePath("api");
beanConfig.setResourcePackage("com.programmingskillz.samplejerseywebapp.web");
beanConfig.setScan(true);
beanConfig.setPrettyPrint(true);
}
示例13: JaxRsActivator
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
public JaxRsActivator() {
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);
}
示例14: JaxRsActivator
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
public JaxRsActivator() {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setVersion("1.0.0");
beanConfig.setSchemes(new String[] { "http" });
beanConfig.setTitle("The Deploy Master demo REST API");
beanConfig.setDescription("Operations that can be invoked in this demo");
beanConfig.setResourcePackage("com.redhat.developers.rest");
beanConfig.setLicense("Apache 2.0");
beanConfig.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html");
beanConfig.setContact("[email protected]");
beanConfig.setBasePath("/demo/api");
beanConfig.setPrettyPrint(true);
beanConfig.setScan(true);
}
示例15: contextInitialized
import io.swagger.jaxrs.config.BeanConfig; //导入方法依赖的package包/类
@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);
}