本文整理了Java中io.swagger.annotations.Api.description()
方法的一些代码示例,展示了Api.description()
的具体用法。这些代码示例主要来源于Github
/Stackoverflow
/Maven
等平台,是从一些精选项目中提取出来的代码,具有较强的参考意义,能在一定程度帮忙到你。Api.description()
方法的具体详情如下:
包路径:io.swagger.annotations.Api
类名称:Api
方法名:description
暂无
代码示例来源:origin: Graylog2/graylog2-server
public synchronized Map<String, Object> generateOverview() {
if (!overviewResult.isEmpty()) {
return overviewResult;
}
final List<Map<String, Object>> apis = Lists.newArrayList();
for (Class<?> clazz : getAnnotatedClasses()) {
Api info = clazz.getAnnotation(Api.class);
Path path = clazz.getAnnotation(Path.class);
if (info == null || path == null) {
LOG.debug("Skipping REST resource with no Api or Path annotation: <{}>", clazz.getCanonicalName());
continue;
}
final String prefixedPath = prefixedPath(clazz, path.value());
final Map<String, Object> apiDescription = Maps.newHashMap();
apiDescription.put("name", prefixedPath.startsWith(pluginPathPrefix) ? "Plugins/" + info.value() : info.value());
apiDescription.put("path", prefixedPath);
apiDescription.put("description", info.description());
apis.add(apiDescription);
}
Collections.sort(apis, (o1, o2) -> ComparisonChain.start().compare(o1.get("name").toString(), o2.get("name").toString()).result());
Map<String, String> info = Maps.newHashMap();
info.put("title", "Graylog REST API");
overviewResult.put("apiVersion", ServerVersion.VERSION.toString());
overviewResult.put("swaggerVersion", EMULATED_SWAGGER_VERSION);
overviewResult.put("apis", apis);
return overviewResult;
}
代码示例来源:origin: kongchen/swagger-maven-plugin
protected Set<Tag> extractTags(Api api) {
Set<Tag> output = new LinkedHashSet<>();
if(api == null) {
return output;
}
boolean hasExplicitTags = false;
for (String tag : api.tags()) {
if (!tag.isEmpty()) {
hasExplicitTags = true;
output.add(new Tag().name(tag));
}
}
if (!hasExplicitTags) {
// derive tag from api path + description
String tagString = api.value().replace("/", "");
if (!tagString.isEmpty()) {
Tag tag = new Tag().name(tagString);
if (!api.description().isEmpty()) {
tag.description(api.description());
}
output.add(tag);
}
}
return output;
}
代码示例来源:origin: io.springfox/springfox-swagger-common
@Override
public String apply(Api input) {
return input.description();
}
};
代码示例来源:origin: io.springfox/springfox-swagger-common
@Override
public Optional<String> apply(Api input) {
if (null != input) {
return fromNullable(emptyToNull(input.description()));
}
return Optional.absent();
}
};
代码示例来源:origin: com.outbrain.swinfra/ob1k-swagger
private Tag buildTag(final Class<?> serviceClass) {
final Api annotation = serviceClass.getAnnotation(Api.class);
final String name = (annotation != null) ? annotation.value() : serviceClass.getSimpleName();
final String description = (annotation != null) ? annotation.description() : serviceClass.getCanonicalName();
return new Tag().name(name).description(description);
}
代码示例来源:origin: org.graylog2/graylog2-server
public synchronized Map<String, Object> generateOverview() {
if (!overviewResult.isEmpty()) {
return overviewResult;
}
final List<Map<String, Object>> apis = Lists.newArrayList();
for (Class<?> clazz : getAnnotatedClasses()) {
Api info = clazz.getAnnotation(Api.class);
Path path = clazz.getAnnotation(Path.class);
if (info == null || path == null) {
LOG.debug("Skipping REST resource with no Api or Path annotation: <{}>", clazz.getCanonicalName());
continue;
}
final String prefixedPath = prefixedPath(clazz, path.value());
final Map<String, Object> apiDescription = Maps.newHashMap();
apiDescription.put("name", prefixedPath.startsWith(pluginPathPrefix) ? "Plugins/" + info.value() : info.value());
apiDescription.put("path", prefixedPath);
apiDescription.put("description", info.description());
apis.add(apiDescription);
}
Collections.sort(apis, (o1, o2) -> ComparisonChain.start().compare(o1.get("name").toString(), o2.get("name").toString()).result());
Map<String, String> info = Maps.newHashMap();
info.put("title", "Graylog REST API");
overviewResult.put("apiVersion", ServerVersion.VERSION.toString());
overviewResult.put("swaggerVersion", EMULATED_SWAGGER_VERSION);
overviewResult.put("apis", apis);
return overviewResult;
}
代码示例来源:origin: outbrain/ob1k
private Tag buildTag(final Class<?> serviceClass) {
final Api annotation = serviceClass.getAnnotation(Api.class);
final String name = (annotation != null) ? annotation.value() : serviceClass.getSimpleName();
final String description = (annotation != null) ? annotation.description() : serviceClass.getCanonicalName();
return new Tag().name(name).description(description);
}
代码示例来源:origin: 7040210/SuperBoot
impResource.setServiceName(StringUtils.join(api_annotation.tags(), ","));
description = api_annotation.description();
内容来源于网络,如有侵权,请联系作者删除!