--- /dev/null
+/*
+ * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.sal.rest.doc.impl;
+
+import java.io.IOException;
+import java.net.URI;
+import java.text.DateFormat;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Date;
+import java.util.List;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
+
+import javax.ws.rs.core.UriInfo;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+import org.opendaylight.controller.sal.rest.doc.model.builder.OperationBuilder;
+import org.opendaylight.controller.sal.rest.doc.swagger.Api;
+import org.opendaylight.controller.sal.rest.doc.swagger.ApiDeclaration;
+import org.opendaylight.controller.sal.rest.doc.swagger.Operation;
+import org.opendaylight.controller.sal.rest.doc.swagger.Parameter;
+import org.opendaylight.controller.sal.rest.doc.swagger.Resource;
+import org.opendaylight.controller.sal.rest.doc.swagger.ResourceList;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsonorg.JsonOrgModule;
+import com.google.common.base.Preconditions;
+
+public class BaseYangSwaggerGenerator {
+
+ private static Logger _logger = LoggerFactory.getLogger(BaseYangSwaggerGenerator.class);
+
+ protected static final String API_VERSION = "1.0.0";
+ protected static final String SWAGGER_VERSION = "1.2";
+ protected static final String RESTCONF_CONTEXT_ROOT = "restconf";
+ protected final DateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
+ private final ModelGenerator jsonConverter = new ModelGenerator();
+
+ // private Map<String, ApiDeclaration> MODULE_DOC_CACHE = new HashMap<>()
+ private final ObjectMapper mapper = new ObjectMapper();
+
+ protected BaseYangSwaggerGenerator() {
+ mapper.registerModule(new JsonOrgModule());
+ mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
+ }
+
+ /**
+ *
+ * @param uriInfo
+ * @param operType
+ * @return list of modules converted to swagger compliant resource list.
+ */
+ public ResourceList getResourceListing(UriInfo uriInfo, SchemaContext schemaContext,
+ String context) {
+
+ ResourceList resourceList = createResourceList();
+
+ Set<Module> modules = getSortedModules(schemaContext);
+
+ List<Resource> resources = new ArrayList<>(modules.size());
+
+ _logger.info("Modules found [{}]", modules.size());
+
+ for (Module module : modules) {
+ String revisionString = SIMPLE_DATE_FORMAT.format(module.getRevision());
+
+ Resource resource = new Resource();
+ _logger.debug("Working on [{},{}]...", module.getName(), revisionString);
+ ApiDeclaration doc = getApiDeclaration(module.getName(), revisionString, uriInfo,
+ schemaContext, context);
+
+ if (doc != null) {
+ resource.setPath(generatePath(uriInfo, module.getName(), revisionString));
+ resources.add(resource);
+ } else {
+ _logger.debug("Could not generate doc for {},{}", module.getName(), revisionString);
+ }
+ }
+
+ resourceList.setApis(resources);
+
+ return resourceList;
+ }
+
+ protected ResourceList createResourceList() {
+ ResourceList resourceList = new ResourceList();
+ resourceList.setApiVersion(API_VERSION);
+ resourceList.setSwaggerVersion(SWAGGER_VERSION);
+ return resourceList;
+ }
+
+ protected String generatePath(UriInfo uriInfo, String name, String revision) {
+ URI uri = uriInfo.getRequestUriBuilder().path(generateCacheKey(name, revision)).build();
+ return uri.toASCIIString();
+ }
+
+ public ApiDeclaration getApiDeclaration(String module, String revision, UriInfo uriInfo,
+ SchemaContext schemaContext, String context) {
+ Date rev = null;
+ try {
+ rev = SIMPLE_DATE_FORMAT.parse(revision);
+ } catch (ParseException e) {
+ throw new IllegalArgumentException(e);
+ }
+ Module m = schemaContext.findModuleByName(module, rev);
+ Preconditions.checkArgument(m != null, "Could not find module by name,revision: " + module
+ + "," + revision);
+
+ return getApiDeclaration(m, rev, uriInfo, schemaContext, context);
+ }
+
+ public ApiDeclaration getApiDeclaration(Module module, Date revision, UriInfo uriInfo,
+ SchemaContext schemaContext, String context) {
+ String basePath = createBasePathFromUriInfo(uriInfo);
+
+ ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context);
+ if (doc != null) {
+ return doc;
+ }
+ return null;
+ }
+
+ protected String createBasePathFromUriInfo(UriInfo uriInfo) {
+ String portPart = "";
+ int port = uriInfo.getBaseUri().getPort();
+ if (port != -1) {
+ portPart = ":" + port;
+ }
+ String basePath = new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://")
+ .append(uriInfo.getBaseUri().getHost()).append(portPart).append("/")
+ .append(RESTCONF_CONTEXT_ROOT).toString();
+ return basePath;
+ }
+
+ public ApiDeclaration getSwaggerDocSpec(Module m, String basePath, String context) {
+ ApiDeclaration doc = createApiDeclaration(basePath);
+
+ List<Api> apis = new ArrayList<Api>();
+
+ Set<DataSchemaNode> dataSchemaNodes = m.getChildNodes();
+ _logger.debug("child nodes size [{}]", dataSchemaNodes.size());
+ for (DataSchemaNode node : dataSchemaNodes) {
+ if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
+
+ _logger.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node
+ .getQName().getLocalName());
+
+ List<Parameter> pathParams = new ArrayList<Parameter>();
+ String resourcePath = getDataStorePath("/config/", context) + m.getName() + ":";
+ addApis(node, apis, resourcePath, pathParams, true);
+
+ pathParams = new ArrayList<Parameter>();
+ resourcePath = getDataStorePath("/operational/", context) + m.getName() + ":";
+ addApis(node, apis, resourcePath, pathParams, false);
+ }
+
+ Set<RpcDefinition> rpcs = m.getRpcs();
+ for (RpcDefinition rpcDefinition : rpcs) {
+ String resourcePath = getDataStorePath("/operations/", context) + m.getName() + ":";
+ addRpcs(rpcDefinition, apis, resourcePath);
+ }
+ }
+
+ _logger.debug("Number of APIs found [{}]", apis.size());
+
+ if (!apis.isEmpty()) {
+ doc.setApis(apis);
+ JSONObject models = null;
+
+ try {
+ models = jsonConverter.convertToJsonSchema(m);
+ doc.setModels(models);
+ if (_logger.isDebugEnabled()) {
+ _logger.debug(mapper.writeValueAsString(doc));
+ }
+ } catch (IOException | JSONException e) {
+ e.printStackTrace();
+ }
+
+ return doc;
+ }
+ return null;
+ }
+
+ protected ApiDeclaration createApiDeclaration(String basePath) {
+ ApiDeclaration doc = new ApiDeclaration();
+ doc.setApiVersion(API_VERSION);
+ doc.setSwaggerVersion(SWAGGER_VERSION);
+ doc.setBasePath(basePath);
+ doc.setProduces(Arrays.asList("application/json", "application/xml"));
+ return doc;
+ }
+
+ protected String getDataStorePath(String dataStore, String context) {
+ return dataStore + context;
+ }
+
+ private String generateCacheKey(Module m) {
+ return generateCacheKey(m.getName(), SIMPLE_DATE_FORMAT.format(m.getRevision()));
+ }
+
+ private String generateCacheKey(String module, String revision) {
+ return module + "(" + revision + ")";
+ }
+
+ private void addApis(DataSchemaNode node, List<Api> apis, String parentPath,
+ List<Parameter> parentPathParams, boolean addConfigApi) {
+
+ Api api = new Api();
+ List<Parameter> pathParams = new ArrayList<Parameter>(parentPathParams);
+
+ String resourcePath = parentPath + createPath(node, pathParams) + "/";
+ _logger.debug("Adding path: [{}]", resourcePath);
+ api.setPath(resourcePath);
+ api.setOperations(operations(node, pathParams, addConfigApi));
+ apis.add(api);
+ if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
+ DataNodeContainer schemaNode = (DataNodeContainer) node;
+ Set<DataSchemaNode> dataSchemaNodes = schemaNode.getChildNodes();
+
+ for (DataSchemaNode childNode : dataSchemaNodes) {
+ // We don't support going to leaf nodes today. Only lists and
+ // containers.
+ if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
+ // keep config and operation attributes separate.
+ if (childNode.isConfiguration() == addConfigApi) {
+ addApis(childNode, apis, resourcePath, pathParams, addConfigApi);
+ }
+ }
+ }
+ }
+
+ }
+
+ /**
+ * @param node
+ * @param pathParams
+ * @return
+ */
+ private List<Operation> operations(DataSchemaNode node, List<Parameter> pathParams,
+ boolean isConfig) {
+ List<Operation> operations = new ArrayList<>();
+
+ OperationBuilder.Get getBuilder = new OperationBuilder.Get(node, isConfig);
+ operations.add(getBuilder.pathParams(pathParams).build());
+
+ if (isConfig) {
+ OperationBuilder.Post postBuilder = new OperationBuilder.Post(node);
+ operations.add(postBuilder.pathParams(pathParams).build());
+
+ OperationBuilder.Put putBuilder = new OperationBuilder.Put(node);
+ operations.add(putBuilder.pathParams(pathParams).build());
+
+ OperationBuilder.Delete deleteBuilder = new OperationBuilder.Delete(node);
+ operations.add(deleteBuilder.pathParams(pathParams).build());
+ }
+ return operations;
+ }
+
+ private String createPath(final DataSchemaNode schemaNode, List<Parameter> pathParams) {
+ ArrayList<LeafSchemaNode> pathListParams = new ArrayList<LeafSchemaNode>();
+ StringBuilder path = new StringBuilder();
+ QName _qName = schemaNode.getQName();
+ String localName = _qName.getLocalName();
+ path.append(localName);
+
+ if ((schemaNode instanceof ListSchemaNode)) {
+ final List<QName> listKeys = ((ListSchemaNode) schemaNode).getKeyDefinition();
+ for (final QName listKey : listKeys) {
+ {
+ DataSchemaNode _dataChildByName = ((DataNodeContainer) schemaNode)
+ .getDataChildByName(listKey);
+ pathListParams.add(((LeafSchemaNode) _dataChildByName));
+
+ String pathParamIdentifier = new StringBuilder("/{")
+ .append(listKey.getLocalName()).append("}").toString();
+ path.append(pathParamIdentifier);
+
+ Parameter pathParam = new Parameter();
+ pathParam.setName(listKey.getLocalName());
+ pathParam.setDescription(_dataChildByName.getDescription());
+ pathParam.setType("string");
+ pathParam.setParamType("path");
+
+ pathParams.add(pathParam);
+ }
+ }
+ }
+ return path.toString();
+ }
+
+ protected void addRpcs(RpcDefinition rpcDefn, List<Api> apis, String parentPath) {
+ Api rpc = new Api();
+ String resourcePath = parentPath + rpcDefn.getQName().getLocalName();
+ rpc.setPath(resourcePath);
+
+ Operation operationSpec = new Operation();
+ operationSpec.setMethod("POST");
+ operationSpec.setNotes(rpcDefn.getDescription());
+ operationSpec.setNickname(rpcDefn.getQName().getLocalName());
+ if (rpcDefn.getOutput() != null) {
+ operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output");
+ }
+ if (rpcDefn.getInput() != null) {
+ Parameter payload = new Parameter();
+ payload.setParamType("body");
+ payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input");
+ operationSpec.setParameters(Collections.singletonList(payload));
+ }
+
+ rpc.setOperations(Arrays.asList(operationSpec));
+
+ apis.add(rpc);
+ }
+
+ protected SortedSet<Module> getSortedModules(SchemaContext schemaContext) {
+ if (schemaContext == null) {
+ return new TreeSet<>();
+ }
+
+ Set<Module> modules = schemaContext.getModules();
+
+ SortedSet<Module> sortedModules = new TreeSet<>(new Comparator<Module>() {
+ @Override
+ public int compare(Module o1, Module o2) {
+ int result = o1.getName().compareTo(o2.getName());
+ if (result == 0) {
+ result = o1.getRevision().compareTo(o2.getRevision());
+ }
+ if (result == 0) {
+ result = o1.getNamespace().compareTo(o2.getNamespace());
+ }
+ return result;
+ }
+ });
+ for (Module m : modules) {
+ if (m != null) {
+ sortedModules.add(m);
+ }
+ }
+ return sortedModules;
+ }
+}
Code Review / controller.git / blobdiff