Swagger generate() {
this.swagger = new Swagger();
swagger.basePath(basePath);
swagger.info(
new Info()
.version(
"0.0.0") // TODO: provide some way of passing the name, version etc (some sort of
// SPI service?)
.title(visibility.name() + " API"));
appendRestfulObjectsSupportingPathsAndDefinitions();
appendLinkModelDefinition();
appendServicePathsAndDefinitions();
appendObjectPathsAndDefinitions();
appendDefinitionsForOrphanedReferences();
return swagger;
}
public Swagger filter(
Swagger swagger,
SwaggerSpecFilter filter,
Map<String, List<String>> params,
Map<String, String> cookies,
Map<String, List<String>> headers) {
Swagger clone = new Swagger();
clone
.info(swagger.getInfo())
.tags(swagger.getTags() == null ? null : new ArrayList<Tag>(swagger.getTags()))
.host(swagger.getHost())
.basePath(swagger.getBasePath())
.schemes(swagger.getSchemes())
.consumes(swagger.getConsumes())
.produces(swagger.getProduces())
.externalDocs(swagger.getExternalDocs())
.vendorExtensions(swagger.getVendorExtensions());
final Set<String> filteredTags = new HashSet<String>();
final Set<String> allowedTags = new HashSet<String>();
for (String resourcePath : swagger.getPaths().keySet()) {
Path path = swagger.getPaths().get(resourcePath);
Map<String, Operation> ops = new HashMap<String, Operation>();
ops.put("get", path.getGet());
ops.put("put", path.getPut());
ops.put("post", path.getPost());
ops.put("delete", path.getDelete());
ops.put("patch", path.getPatch());
ops.put("options", path.getOptions());
Path clonedPath = new Path();
for (String key : ops.keySet()) {
Operation op = ops.get(key);
if (op != null) {
ApiDescription desc = new ApiDescription(resourcePath, key);
final Set<String> tags;
if (filter.isOperationAllowed(op, desc, params, cookies, headers)) {
clonedPath.set(key, filterOperation(filter, op, desc, params, cookies, headers));
tags = allowedTags;
} else {
tags = filteredTags;
}
if (op.getTags() != null) {
tags.addAll(op.getTags());
}
}
}
if (!clonedPath.isEmpty()) {
clone.path(resourcePath, clonedPath);
}
}
final List<Tag> tags = clone.getTags();
filteredTags.removeAll(allowedTags);
if (tags != null && !filteredTags.isEmpty()) {
for (Iterator<Tag> it = tags.iterator(); it.hasNext(); ) {
if (filteredTags.contains(it.next().getName())) {
it.remove();
}
}
if (clone.getTags().isEmpty()) {
clone.setTags(null);
}
}
Map<String, Model> definitions =
filterDefinitions(filter, swagger.getDefinitions(), params, cookies, headers);
clone.setSecurityDefinitions(swagger.getSecurityDefinitions());
clone.setDefinitions(definitions);
// isRemovingUnreferencedDefinitions is not defined in SwaggerSpecFilter to avoid breaking
// compatibility with
// existing client filters directly implementing SwaggerSpecFilter.
if (filter instanceof AbstractSpecFilter) {
if (((AbstractSpecFilter) filter).isRemovingUnreferencedDefinitions()) {
clone = removeBrokenReferenceDefinitions(clone);
}
}
return clone;
}
public Swagger parseRoot(JsonNode node, ParseResult result) {
String location = "";
Swagger swagger = new Swagger();
if (node.getNodeType().equals(JsonNodeType.OBJECT)) {
ObjectNode on = (ObjectNode) node;
Iterator<JsonNode> it = null;
// required
String value = getString("swagger", on, true, location, result);
swagger.setSwagger(value);
ObjectNode obj = getObject("info", on, true, "", result);
if (obj != null) {
Info info = info(obj, "info", result);
swagger.info(info);
}
// optional
value = getString("host", on, false, location, result);
swagger.setHost(value);
value = getString("basePath", on, false, location, result);
swagger.setBasePath(value);
ArrayNode array = getArray("schemes", on, false, location, result);
if (array != null) {
it = array.iterator();
while (it.hasNext()) {
JsonNode n = it.next();
String s = getString(n, location + ".schemes", result);
if (s != null) {
Scheme scheme = Scheme.forValue(s);
if (scheme != null) {
swagger.scheme(scheme);
}
}
}
}
array = getArray("consumes", on, false, location, result);
if (array != null) {
it = array.iterator();
while (it.hasNext()) {
JsonNode n = it.next();
String s = getString(n, location + ".consumes", result);
if (s != null) {
swagger.consumes(s);
}
}
}
array = getArray("produces", on, false, location, result);
if (array != null) {
it = array.iterator();
while (it.hasNext()) {
JsonNode n = it.next();
String s = getString(n, location + ".produces", result);
if (s != null) {
swagger.produces(s);
}
}
}
obj = getObject("paths", on, true, location, result);
Map<String, Path> paths = paths(obj, "paths", result);
swagger.paths(paths);
obj = getObject("definitions", on, false, location, result);
Map<String, Model> definitions = definitions(obj, "definitions", result);
swagger.setDefinitions(definitions);
obj = getObject("parameters", on, false, location, result);
// TODO: parse
Map<String, Parameter> parameters =
Json.mapper()
.convertValue(
obj,
Json.mapper()
.getTypeFactory()
.constructMapType(Map.class, String.class, Parameter.class));
swagger.setParameters(parameters);
obj = getObject("responses", on, false, location, result);
Map<String, Response> responses = responses(obj, "responses", result);
swagger.responses(responses);
obj = getObject("securityDefinitions", on, false, location, result);
Map<String, SecuritySchemeDefinition> securityDefinitions =
securityDefinitions(obj, location, result);
swagger.setSecurityDefinitions(securityDefinitions);
array = getArray("security", on, false, location, result);
List<SecurityRequirement> security = securityRequirements(array, location, result);
swagger.setSecurity(security);
array = getArray("tags", on, false, location, result);
List<Tag> tags = tags(array, location, result);
swagger.tags(tags);
obj = getObject("externalDocs", on, false, location, result);
ExternalDocs docs = externalDocs(obj, location, result);
swagger.externalDocs(docs);
// extra keys
Set<String> keys = getKeys(on);
for (String key : keys) {
if (key.startsWith("x-")) {
swagger.vendorExtension(key, extension(on.get(key)));
} else if (!ROOT_KEYS.contains(key)) {
result.extra(location, key, node.get(key));
}
}
} else {
result.invalidType("", "", "object", node);
result.invalid();
return null;
}
return swagger;
}