def build_param(self, wadl_param):
self.logger.debug("Found param: %s" % wadl_param.name)
param = OrderedDict()
param['name'] = wadl_param.name
param['required'] = wadl_param.is_required
param['in'] = self.style_to_in(wadl_param.style)
wadl_type = wadl_param.tag.get('type', 'string')
json_type = self.xsd_to_json_type(wadl_type)
if json_type is None:
self.logger.warn("Unknown type: %s for param %s", wadl_type,
wadl_param.name)
if self.autofix:
self.logger.warn("Using string for %s", wadl_type)
json_type = "string"
else:
json_type = wadl_type
if isinstance(json_type, dict):
param.update(json_type)
else:
param["type"] = json_type
if self.autofix:
if param['in'] == 'body':
self.logger.warn(
"Ignoring body parameter, converting these is not yet supported..."
)
return None
if param['in'] == 'path':
if param['required'] is not True:
self.logger.warn(
"Autofix: path parameters must be required in Swagger (%s)",
param['name'])
param['required'] = True
if self.options.nodoc is not True:
if DocHelper.doc_tag(wadl_param) is not None and DocHelper.doc_tag(
wadl_param).text is not None:
description = DocHelper.docbook_to_markdown(
DocHelper.doc_tag(wadl_param))
# Cleanup whitespace...
description = textwrap.dedent(description)
param["description"] = folded(description)
return param
def build_response(self, wadl_response):
status = wadl_response.tag.attrib['status']
try:
description = ' '.join(
DocHelper.doc_tag(wadl_response).text.split())
except:
description = "%s response" % status
return {"description": folded(description)}
def build_response(self, wadl_response):
status = wadl_response.tag.attrib['status']
try:
description = ' '.join(
DocHelper.doc_tag(wadl_response).text.split())
except:
description = "%s response" % status
return {
"description": folded(description)
}
def build_param(self, wadl_param):
self.logger.debug("Found param: %s" % wadl_param.name)
param = OrderedDict()
param['name'] = wadl_param.name
param['required'] = wadl_param.is_required
param['in'] = self.style_to_in(wadl_param.style)
wadl_type = wadl_param.tag.get('type', 'string')
json_type = self.xsd_to_json_type(wadl_type)
if json_type is None:
self.logger.warn("Unknown type: %s for param %s", wadl_type, wadl_param.name)
if self.autofix:
self.logger.warn("Using string for %s", wadl_type)
json_type = "string"
else:
json_type = wadl_type
if isinstance(json_type, dict):
param.update(json_type)
else:
param["type"] = json_type
if self.autofix:
if param['in'] == 'body':
self.logger.warn("Ignoring body parameter, converting these is not yet supported...")
return None
if param['in'] == 'path':
if param['required'] is not True:
self.logger.warn("Autofix: path parameters must be required in Swagger (%s)", param['name'])
param['required'] = True
if self.options.nodoc is not True:
if DocHelper.doc_tag(wadl_param) is not None and DocHelper.doc_tag(wadl_param).text is not None:
description = DocHelper.docbook_to_markdown(
DocHelper.doc_tag(wadl_param))
# Cleanup whitespace...
description = textwrap.dedent(description)
param["description"] = folded(description)
return param
def convert(self, title, wadl_file, swagger_file):
try:
self.logger = logging.getLogger(wadl_file)
self.logger.info("Converting: %s to %s", wadl_file, swagger_file)
defaults = self.default_swagger_dict(swagger_file)
wadl = WADL.application_for(wadl_file)
if self.autofix and wadl.resource_base is None:
self.logger.warn(
"Autofix: No base path, setting to http://localhost")
wadl.resource_base = 'http://localhost'
self.logger.debug("Reading WADL from %s", wadl_file)
swagger = OrderedDict()
swagger['swagger'] = '2.0'
swagger['info'] = OrderedDict()
try:
swagger['info'] = defaults['info']
except KeyError:
swagger['info']['title'] = title
swagger['info']['version'] = "Unknown"
try:
swagger['consumes'] = defaults['consumes']
swagger['produces'] = defaults['produces']
except KeyError:
swagger["consumes"] = ["application/json"]
swagger["produces"] = ["application/json"]
swagger['paths'] = OrderedDict()
for resource_element in wadl.resources:
path = resource_element.attrib['path']
resource = wadl.get_resource_by_path(path)
if self.autofix and not path.startswith('/'):
self.logger.warn("Autofix: Adding leading / to path")
path = '/' + path
swagger_resource = swagger["paths"][path] = OrderedDict()
self.logger.debug(" Processing resource for %s", path)
# Resource level parameters
try:
# wadllib can't get parameters w/out media types (e.g. path
# params?)
try:
params = resource.parameters('application/json')
except (UnsupportedMediaTypeError, AttributeError):
self.logger.warn(
"No support for application/json for resource at %s", path)
params = []
for param in resource.tag.findall('./' + WADL.qname('wadl', 'param')):
params.append(
wadllib.application.Parameter(resource, param))
for param in params:
swagger_param = self.build_param(param)
if swagger_param is not None:
if "parameters" not in swagger_resource:
swagger_resource["parameters"] = []
swagger_resource["parameters"].append(swagger_param)
except AttributeError:
self.logger.debug(
" WARN: wadllib can't get parameters, possibly a wadllib bug")
self.logger.debug(
" (It seems like it only works if the resource has a GET method")
for method in resource.method_iter:
self.logger.debug(
" Processing method %s %s", method.name, path)
verb = method.name
if self.autofix and verb == 'copy':
self.logger.warn(
"Autofix: Using PUT instead of COPY verb (OpenStack services accept either, Swagger does not allow COPY)")
verb = 'put'
swagger_method = swagger_resource[verb] = OrderedDict()
# Rackspace specific...
if '{http://docs.rackspace.com/api}id' in method.tag.attrib:
swagger_method['operationId'] = method.tag.attrib[
'{http://docs.rackspace.com/api}id']
swagger_method['summary'] = self.build_summary(method)
description = DocHelper.short_desc_as_markdown(method)
if description is not None:
swagger_method['description'] = folded(description)
# swagger_method['operationId'] = method.tag.attrib['id']
# swagger_method['consumes'] = []
swagger_method['produces'] = []
swagger_method['responses'] = OrderedDict()
if method.request.tag is not None:
request = method.request
for representation in request.representations:
# Swagger schema needs to be updated to allow consumes here
# swagger_method['consumes'].append(representation.media_type)
for param in representation.params(resource):
swagger_param = self.build_param(param)
if swagger_param is not None:
if "parameters" not in swagger_method:
swagger_method["parameters"] = []
swagger_method["parameters"].append(swagger_param)
if method.response.tag is not None:
response = method.response
# Not properly iterable - plus we're focused on json
# for representation in response.representation:
representation = response.get_representation_definition(
'application/json')
if representation is not None:
swagger_method['produces'].append(
representation.media_type)
try:
statuses = response.tag.attrib['status'].split()
except KeyError as e:
raise BadWADLError(
"Response has no status", e, wadl_file)
for status in statuses:
swagger_method['responses'][
int(status)] = self.build_response(response)
code_sample = None
code_samples = response.tag.findall(
'.//' + WADL.qname('docbook', 'programlisting') + '[@language="javascript"]')
if code_samples:
try:
# if there is more than one, the first is
# usually HTTP headers
code_sample = code_samples[-1].text
code_sample = self.fix_json(code_sample)
except ValueError as e:
error = WADLParseError(
"Unparsable code sample", wadl_file, swagger_method['summary'], e)
if self.strict:
raise error
else:
self.logger.error(str(error))
if code_sample:
swagger_method['responses'][
int(status)]['examples'] = self.build_code_sample(code_sample)
swagger = merge_dicts(swagger, defaults)
return swagger
except WADLError as e:
# except Exception as e:
raise BadWADLError("Could not convert WADL", e, wadl_file)
def build_summary(self, documented_wadl_object):
return DocHelper.doc_tag(documented_wadl_object).attrib['title']
def convert(self, title, wadl_file, swagger_file):
try:
self.logger = logging.getLogger(wadl_file)
self.logger.info("Converting: %s to %s", wadl_file, swagger_file)
defaults = self.default_swagger_dict(swagger_file)
wadl = WADL.application_for(wadl_file)
if self.autofix and wadl.resource_base is None:
self.logger.warn(
"Autofix: No base path, setting to http://localhost")
wadl.resource_base = 'http://localhost'
self.logger.debug("Reading WADL from %s", wadl_file)
swagger = OrderedDict()
swagger['swagger'] = '2.0'
swagger['info'] = OrderedDict()
try:
swagger['info'] = defaults['info']
except KeyError:
swagger['info']['title'] = title
swagger['info']['version'] = "Unknown"
try:
swagger['consumes'] = defaults['consumes']
swagger['produces'] = defaults['produces']
except KeyError:
swagger["consumes"] = ["application/json"]
swagger["produces"] = ["application/json"]
swagger['paths'] = OrderedDict()
for resource_element in wadl.resources:
path = resource_element.attrib['path']
resource = wadl.get_resource_by_path(path)
if self.autofix and not path.startswith('/'):
self.logger.warn("Autofix: Adding leading / to path")
path = '/' + path
swagger_resource = swagger["paths"][path] = OrderedDict()
self.logger.debug(" Processing resource for %s", path)
# Resource level parameters
try:
# wadllib can't get parameters w/out media types (e.g. path
# params?)
try:
params = resource.parameters('application/json')
except (UnsupportedMediaTypeError, AttributeError):
self.logger.warn(
"No support for application/json for resource at %s",
path)
params = []
for param in resource.tag.findall(
'./' + WADL.qname('wadl', 'param')):
params.append(
wadllib.application.Parameter(resource, param))
for param in params:
swagger_param = self.build_param(param)
if swagger_param is not None:
if "parameters" not in swagger_resource:
swagger_resource["parameters"] = []
swagger_resource["parameters"].append(
swagger_param)
except AttributeError:
self.logger.debug(
" WARN: wadllib can't get parameters, possibly a wadllib bug"
)
self.logger.debug(
" (It seems like it only works if the resource has a GET method"
)
for method in resource.method_iter:
self.logger.debug(" Processing method %s %s",
method.name, path)
verb = method.name
if self.autofix and verb == 'copy':
self.logger.warn(
"Autofix: Using PUT instead of COPY verb (OpenStack services accept either, Swagger does not allow COPY)"
)
verb = 'put'
swagger_method = swagger_resource[verb] = OrderedDict()
# Rackspace specific...
if '{http://docs.rackspace.com/api}id' in method.tag.attrib:
swagger_method['operationId'] = method.tag.attrib[
'{http://docs.rackspace.com/api}id']
swagger_method['summary'] = self.build_summary(method)
description = DocHelper.short_desc_as_markdown(method)
if description is not None:
swagger_method['description'] = folded(description)
# swagger_method['operationId'] = method.tag.attrib['id']
# swagger_method['consumes'] = []
swagger_method['produces'] = []
swagger_method['responses'] = OrderedDict()
if method.request.tag is not None:
request = method.request
for representation in request.representations:
# Swagger schema needs to be updated to allow consumes here
# swagger_method['consumes'].append(representation.media_type)
for param in representation.params(resource):
swagger_param = self.build_param(param)
if swagger_param is not None:
if "parameters" not in swagger_method:
swagger_method["parameters"] = []
swagger_method["parameters"].append(
swagger_param)
if method.response.tag is not None:
response = method.response
# Not properly iterable - plus we're focused on json
# for representation in response.representation:
representation = response.get_representation_definition(
'application/json')
if representation is not None:
swagger_method['produces'].append(
representation.media_type)
try:
statuses = response.tag.attrib['status'].split()
except KeyError as e:
raise BadWADLError("Response has no status", e,
wadl_file)
for status in statuses:
swagger_method['responses'][int(
status)] = self.build_response(response)
code_sample = None
code_samples = response.tag.findall(
'.//' +
WADL.qname('docbook', 'programlisting') +
'[@language="javascript"]')
if code_samples:
try:
# if there is more than one, the first is
# usually HTTP headers
code_sample = code_samples[-1].text
code_sample = self.fix_json(code_sample)
except ValueError as e:
error = WADLParseError(
"Unparsable code sample", wadl_file,
swagger_method['summary'], e)
if self.strict:
raise error
else:
self.logger.error(str(error))
if code_sample:
swagger_method['responses'][int(status)][
'examples'] = self.build_code_sample(
code_sample)
swagger = merge_dicts(swagger, defaults)
return swagger
except WADLError as e:
# except Exception as e:
raise BadWADLError("Could not convert WADL", e, wadl_file)
def build_summary(self, documented_wadl_object):
return DocHelper.doc_tag(documented_wadl_object).attrib['title']
