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 11
Expand file tree
/
Copy pathswagger.py
More file actions
228 lines (204 loc) · 6.28 KB
/
swagger.py
File metadata and controls
228 lines (204 loc) · 6.28 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
from coreschema import Object, Array, String, Anything, Boolean
media_type_pattern = '^[^/]+/[^/]'
# TODO Reference
SecurityScheme = Anything() # TODO
XMLObject = Anything() # TODO
Header = Anything() # TODO
Schema = Anything() # TODO
Items = Anything() # TODO
Definitions = Object(additional_properties=Schema)
ExternalDocumentation = Object(
properties={
'description': String(),
'url': String(format='uri')
},
pattern_properties={
'^x-': Anything()
},
required=['url'],
additional_properties=False
)
Tag = Object(
properties={
'name': String(),
'description': String(),
'externalDocs': ExternalDocumentation
},
pattern_properties={
'^x-': Anything()
},
required=['name'],
additional_properties=False
)
Examples = Object(pattern_properties={
media_type_pattern: Anything()
})
Headers = Object(additional_properties=Header)
Response = Object(
properties={
'description': String(),
'schema': Schema,
'headers': Headers,
'examples': Examples
},
pattern_properties={
'^x-': Anything()
},
required=['description'],
additional_properties=False
)
Responses = Object(
properties={
'default': Response # Allow ref
},
pattern_properties={
'^[1-5][0-9][0-9]$': Response, # Allow ref
'^x-': Anything()
},
additional_properties=False
)
Parameter = Object(
properties={
'name': String(), # If 'in' is 'path' then must be segment in path template variable
'in': String(enum=['query', 'header', 'path', 'formData', 'body']),
'description': String(),
'required': Boolean() # If 'in' is 'path' then required and true.
},
additional_properties=True, # TODO body -> schema, others -> ...
required=['name', 'in']
)
Operation = Object(
properties={
'tags': Array(String(), unique_items=True),
'summary': String(), # SHOULD be < 120
'description': String(),
'externalDocs': ExternalDocumentation,
'operationId': String(), # MUST be unique
'consumes': Array(String(pattern=media_type_pattern), unique_items=True),
'produces': Array(String(pattern=media_type_pattern), unique_items=True),
'parameters': Array(Parameter), # Allow ref
'responses': Responses,
'schemes': Array(String(enum=['http', 'https', 'ws', 'wss']), unique_items=True),
'deprecated': Boolean(),
'security': Anything() # TODO
},
pattern_properties={
'^x-': Anything()
},
required=['responses'],
additional_properties=False
)
PathItem = Object(
properties={ # Allow ref
'get': Operation,
'put': Operation,
'post': Operation,
'delete': Operation,
'options': Operation,
'head': Operation,
'patch': Operation,
'parameters': Array(Parameter) # Allow ref
},
pattern_properties={
'^x-': Anything()
},
additional_properties=False
)
Paths = Object(
pattern_properties={
'^/': PathItem,
'^x-': Anything()
},
additional_properties=False
)
License = Object(
properties={
'name': String(),
'url': String(format='uri')
},
pattern_properties={'^x-': Anything()},
required=['name'],
additional_properties=False
)
Contact = Object(
properties={
'name': String(),
'url': String(format='uri'),
'email': String(format='email')
},
pattern_properties={'^x-': Anything()},
additional_properties=False
)
Info = Object(
properties={
'title': String(),
'description': String(),
'termsOfService': String(),
'contact': Contact,
'license': License,
'version': String()
},
pattern_properties={'^x-': Anything()},
required=['title', 'version'],
additional_properties=False
)
Swagger = Object(
properties={
'swagger': String(enum=['2.0']),
'info': Info,
'host': String(),
'basePath': String(),
'schemes': Array(String(enum=['http', 'https', 'ws', 'wss']), unique_items=True),
'consumes': Array(String(pattern=media_type_pattern), unique_items=True),
'produces': Array(String(pattern=media_type_pattern), unique_items=True),
'paths': Paths,
# Definition space... (Used by refs)
'definitions': Object(additional_properties=Schema),
'parameters': Object(additional_properties=Parameter),
'responses': Object(additional_properties=Responses),
'securityDefinitions': Object(additional_properties=SecurityScheme),
# Security space... (Used by ...)
'security': Array(Anything()), # TODO
# Tag space... (Used by operations)
'tags': Array(Tag), # names MUST be unique
'externalDocs': ExternalDocumentation
},
pattern_properties={'^x-': Anything()},
required=['swagger', 'info', 'paths'],
additional_properties=False
)
# swagger = Swagger.parse({
# 'info': {
# 'title': doc.title,
# 'description': doc.description
# },
# 'paths': paths
# })
# swagger.value
#
# swagger = Swagger.parse(input_content)
#
# title = swagger.get(['info', 'title'])
# description = swagger.get(['info', 'description'], default='')
# version = swagger.get(['info', 'version'])
#
# default_schemes = swagger.get('schemes', default=[])
# default_consumes = swagger.get('consumes', default=None)
# default_produces = swagger.get('produces', default=None)
# for path, path_item in swagger.walk_items('PathItem'):
# default_properties = path_item.get('properties', default=[])
# for method, operation in path_item.walk_items('Operation'):
# operation_id = operation.get('operationId')
# tags = operation.get('tags', default=[])
# schemes = operation.get(['schemes'], default=default_schemes)
# consumes = operation.get(['consumes'], default=default_consumes)
# produces = operation.get(['produces'], default=default_produces)
# properties = operation.get(['properties'], default=default_properties)
#
#
# import os
# import json
# input_path = os.path.join(os.path.dirname(os.path.dirname(__file__)), 'petstore.json')
# schema = json.loads(open(input_path, 'r').read())
#
# print Swagger.validate(schema)