This repository was archived by the owner on Mar 18, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
Expand file tree
/
Copy pathopenapi.py
More file actions
136 lines (117 loc) · 5.12 KB
/
Copy pathopenapi.py
File metadata and controls
136 lines (117 loc) · 5.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
from coreapi.codecs.base import BaseCodec, _get_string, _get_dict, _get_list, _get_bool, get_strings, get_dicts
from coreapi.compat import urlparse
from coreapi.document import Document, Link, Field
from coreapi.exceptions import ParseError
import json
def _expand_schema(schema):
"""
When an OpenAPI parameter uses `in="body"`, and the schema type is "object",
then we expand out the parameters of the object into individual fields.
"""
schema_type = schema.get('type')
schema_properties = _get_dict(schema, 'properties')
schema_required = _get_list(schema, 'required')
if ((schema_type == ['object']) or (schema_type == 'object')) and schema_properties:
return [
(key, key in schema_required)
for key in schema_properties.keys()
]
return None
def _get_document_base_url(data, base_url=None):
"""
Get the base url to use when constructing absolute paths from the
relative ones provided in the schema defination.
"""
prefered_schemes = ['http', 'https']
if base_url:
url_components = urlparse.urlparse(base_url)
default_host = url_components.netloc
default_scheme = url_components.scheme
else:
default_host = ''
default_scheme = None
host = _get_string(data, 'host', default=default_host)
path = _get_string(data, 'basePath', default='/')
if not host:
# No host is provided, and we do not have an initial URL.
return path.strip('/') + '/'
schemes = _get_list(data, 'schemes')
if not schemes:
# No schemes provided, use the initial URL, or a fallback.
scheme = default_scheme or prefered_schemes[0]
elif default_scheme in schemes:
# Schemes provided, the initial URL matches one of them.
scheme = default_scheme
else:
# Schemes provided, the initial URL does not match, pick a fallback.
for scheme in prefered_schemes:
if scheme in schemes:
break
else:
raise ParseError('Unsupported transport schemes "%s"' % schemes)
return '%s://%s/%s/' % (scheme, host, path.strip('/'))
def _parse_document(data, base_url=None):
schema_url = base_url
base_url = _get_document_base_url(data, base_url)
info = _get_dict(data, 'info')
title = _get_string(info, 'title')
paths = _get_dict(data, 'paths')
content = {}
for path in paths.keys():
url = urlparse.urljoin(base_url, path.lstrip('/'))
spec = _get_dict(paths, path)
default_parameters = get_dicts(_get_list(spec, 'parameters'))
for action in spec.keys():
action = action.lower()
if action not in ('get', 'put', 'post', 'delete', 'options', 'head', 'patch'):
continue
operation = _get_dict(spec, action)
# Determine any fields on the link.
fields = []
parameters = get_dicts(_get_list(operation, 'parameters', default_parameters), dereference_using=data)
for parameter in parameters:
name = _get_string(parameter, 'name')
location = _get_string(parameter, 'in')
required = _get_bool(parameter, 'required', default=(location == 'path'))
if location == 'body':
schema = _get_dict(parameter, 'schema', dereference_using=data)
expanded = _expand_schema(schema)
if expanded is not None:
expanded_fields = [
Field(name=field_name, location='form', required=is_required)
for field_name, is_required in expanded
if not any([field.name == name for field in fields])
]
fields += expanded_fields
else:
field = Field(name=name, location='body', required=True)
fields.append(field)
else:
field = Field(name=name, location=location, required=required)
fields.append(field)
link = Link(url=url, action=action, fields=fields)
# Add the link to the document content.
tags = get_strings(_get_list(operation, 'tags'))
operation_id = _get_string(operation, 'operationId')
if tags:
for tag in tags:
if tag not in content:
content[tag] = {}
content[tag][operation_id] = link
else:
content[operation_id] = link
return Document(url=schema_url, title=title, content=content)
class OpenAPICodec(BaseCodec):
media_type = "application/json"
def load(self, bytes, base_url=None):
"""
Takes a bytestring and returns a document.
"""
try:
data = json.loads(bytes.decode('utf-8'))
except ValueError as exc:
raise ParseError('Malformed JSON. %s' % exc)
doc = _parse_document(data, base_url)
if not isinstance(doc, Document):
raise ParseError('Top level node must be a document.')
return doc