forked from ErikWittern/openapi-snippet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger-to-har.js
366 lines (336 loc) · 10.3 KB
/
swagger-to-har.js
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
/**
* Translates given Swagger 2.0 file to an array of HTTP Archive (HAR) 1.2 Request Object.
* See more:
* - http://swagger.io/specification/
* - http://www.softwareishard.com/blog/har-12-spec/#request
*
* Example HAR Request Object:
* "request": {
* "method": "GET",
* "url": "http://www.example.com/path/?param=value",
* "httpVersion": "HTTP/1.1",
* "cookies": [],
* "headers": [],
* "queryString" : [],
* "postData" : {},
* "headersSize" : 150,
* "bodySize" : 0,
* "comment" : ""
* }
*/
var Instantiator = require('./schema-instantiator.js')
/**
* Create HAR Request object for path and method pair described in given swagger.
*
* @param {Object} swagger Swagger document
* @param {string} path Key of the path
* @param {string} method Key of the method
* @param {Object} queryParamValues Optional: Values for the query parameters if present
* @return {Object} HAR Request object
*/
var createHar = function (swagger, path, method, queryParamValues) {
// if the operational parameter is not provided, set it to empty object
if (typeof queryParamValues === 'undefined') {
queryParamValues = {}
}
var baseUrl = getBaseUrl(swagger)
var har = {
method: method.toUpperCase(),
url: baseUrl + path,
headers: getHeadersArray(swagger, path, method),
queryString: getQueryStrings(swagger, path, method, queryParamValues),
httpVersion: 'HTTP/1.1',
cookies: [],
headersSize: 0,
bodySize: 0
}
// get payload data, if available:
var postData = getPayload(swagger, path, method)
if (postData) har.postData = postData
return har
}
/**
* Get the payload definition for the given endpoint (path + method) from the
* given OAI specification. References within the payload definition are
* resolved.
*
* @param {object} swagger
* @param {string} path
* @param {string} method
* @return {object}
*/
var getPayload = function (swagger, path, method) {
if (typeof swagger.paths[path][method].parameters !== 'undefined') {
for (var i in swagger.paths[path][method].parameters) {
var param = swagger.paths[path][method].parameters[i]
if (typeof param.in !== 'undefined' && param.in.toLowerCase() === 'body' &&
typeof param.schema !== 'undefined') {
var schema
if (typeof param.schema['$ref'] === 'undefined') {
schema = param.schema
} else if (/^http/.test(param.schema['$ref'])) {
// can't resolve this for now...
} else {
var ref = param.schema['$ref'].split('/').slice(-1)[0]
schema = getResolvedSchema(swagger, swagger.definitions[ref])
}
return {
mimeType: 'application/json',
text: JSON.stringify(Instantiator.instantiate(schema))
}
}
}
}
return null
}
/**
* Get a complete JSON schema from Swagger, where all references ($ref) are
* resolved. $ref appear:
* - as properties
* - as items
*
* @param {[type]} swagger [description]
* @param {[type]} schema [description]
* @param {[type]} ref [description]
* @return {[type]} [description]
*/
var getResolvedSchema = function (swagger, schema) {
if (schema.type === 'object') {
if (typeof schema.properties !== 'undefined') {
for (var propKey in schema.properties) {
var prop = schema.properties[propKey]
if (typeof prop['$ref'] === 'string' &&
!/^http/.test(prop['$ref'])) {
var ref = prop['$ref'].split('/').slice(-1)[0]
schema.properties[propKey] = swagger.definitions[ref]
}
getResolvedSchema(swagger, schema.properties[propKey])
}
}
} else if (schema.type === 'array') {
if (typeof schema.items !== 'undefined') {
for (var itemKey in schema.items) {
if (itemKey === '$ref' &&
!/^http/.test(schema.items[itemKey])) {
var ref2 = schema.items['$ref'].split('/').slice(-1)[0]
schema.items = swagger.definitions[ref2]
}
getResolvedSchema(swagger, schema.items)
}
}
}
return schema
}
/**
* Gets the base URL constructed from the given swagger.
*
* @param {Object} swagger Swagger document
* @return {string} Base URL
*/
var getBaseUrl = function (swagger) {
var baseUrl = ''
if (typeof swagger.schemes !== 'undefined') {
baseUrl += swagger.schemes[0]
} else {
baseUrl += 'http'
}
if (swagger.basePath === '/') {
baseUrl += '://' + swagger.host
} else {
baseUrl += '://' + swagger.host + swagger.basePath
}
return baseUrl
}
/**
* Get array of objects describing the query parameters for a path and method pair
* described in the given swagger.
*
* @param {Object} swagger Swagger document
* @param {string} path Key of the path
* @param {string} method Key of the method
* @param {Object} values Optional: query parameter values to use in the snippet if present
* @return {array} List of objects describing the query strings
*/
var getQueryStrings = function (swagger, path, method, values) {
// Set the optional parameter if it's not provided
if (typeof values === 'undefined') {
values = {}
}
var queryStrings = []
if (typeof swagger.paths[path][method].parameters !== 'undefined') {
for (var i in swagger.paths[path][method].parameters) {
var param = swagger.paths[path][method].parameters[i]
if (typeof param['$ref'] === 'string' &&
!/^http/.test(param['$ref'])) {
param = resolveRef(swagger, param['$ref'])
}
if (typeof param.in !== 'undefined' && param.in.toLowerCase() === 'query') {
queryStrings.push({
name: param.name,
value: typeof values[param.name] === 'undefined'
? (typeof param.default === 'undefined'
? ('SOME_' + param.type.toUpperCase() + '_VALUE')
: param.default + '')
: (values[param.name] + '') /* adding a empty string to convert to string */
})
}
}
}
return queryStrings
}
/**
* Get an array of objects describing the header for a path and method pair
* described in the given swagger.
*
* @param {Object} swagger Swagger document
* @param {string} path Key of the path
* @param {string} method Key of the method
* @return {array} List of objects describing the header
*/
var getHeadersArray = function (swagger, path, method) {
var headers = []
var pathObj = swagger.paths[path][method]
// 'accept' header:
if (typeof pathObj.consumes !== 'undefined') {
for (var i in pathObj.consumes) {
var type = pathObj.consumes[i]
headers.push({
name: 'accept',
value: type
})
}
}
// 'content-type' header:
if (typeof pathObj.produces !== 'undefined') {
for (var j in pathObj.produces) {
var type2 = pathObj.produces[j]
headers.push({
name: 'content-type',
value: type2
})
}
}
// headers defined in path object:
if (typeof pathObj.parameters !== 'undefined') {
for (var k in pathObj.parameters) {
var param = pathObj.parameters[k]
if (typeof param.in !== 'undefined' && param.in.toLowerCase() === 'header') {
headers.push({
name: param.name,
value: 'SOME_' + param.type.toUpperCase() + '_VALUE'
})
}
}
}
// security:
var basicAuthDef
var apiKeyAuthDef
var oauthDef
if (typeof pathObj.security !== 'undefined') {
for (var l in pathObj.security) {
var secScheme = Object.keys(pathObj.security[l])[0]
var authType = swagger.securityDefinitions[secScheme].type.toLowerCase()
switch (authType) {
case 'basic':
basicAuthDef = secScheme
break
case 'apikey':
if (swagger.securityDefinitions[secScheme].in === 'query') {
apiKeyAuthDef = secScheme
}
break
case 'oauth2':
oauthDef = secScheme
break
}
}
} else if (typeof swagger.security !== 'undefined') {
for (var m in swagger.security) {
var overallSecScheme = Object.keys(swagger.security[m])[0]
var overallAuthType = swagger.securityDefinitions[overallSecScheme].type.toLowerCase()
switch (overallAuthType) {
case 'basic':
basicAuthDef = overallSecScheme
break
case 'apikey':
if (swagger.securityDefinitions[overallSecScheme].in === 'query') {
apiKeyAuthDef = overallSecScheme
}
break
case 'oauth2':
oauthDef = overallSecScheme
break
}
}
}
if (basicAuthDef) {
headers.push({
name: 'Authorization',
value: 'Basic ' + 'REPLACE_BASIC_AUTH'
})
} else if (apiKeyAuthDef) {
headers.push({
name: swagger.securityDefinitions[apiKeyAuthDef].name,
value: 'REPLACE_KEY_VALUE'
})
} else if (oauthDef) {
headers.push({
name: 'Authorization',
value: 'Bearer ' + 'REPLACE_BEARER_TOKEN'
})
}
return headers
}
/**
* Produces array of HAR files for given Swagger document
*
* @param {object} swagger A swagger document
* @param {Function} callback
*/
var swaggerToHarList = function (swagger) {
try {
// determine basePath:
var baseUrl = getBaseUrl(swagger)
// iterate Swagger and create har objects:
var harList = []
for (var path in swagger.paths) {
for (var method in swagger.paths[path]) {
var url = baseUrl + path
var har = createHar(swagger, path, method)
harList.push({
method: method.toUpperCase(),
url: url,
description: swagger.paths[path][method].description || 'No description available',
har: har
})
}
}
return harList
} catch (e) {
return null
}
}
/**
* Returns the value referenced in the given reference string
*
* @param {object} oai
* @param {string} ref A reference string
* @return {any}
*/
var resolveRef = function (oai, ref) {
var parts = ref.split('/')
if (parts.length <= 1) return {} // = 3
var recursive = function (obj, index) {
if (index + 1 < parts.length) { // index = 1
var newCount = index + 1
return recursive(obj[parts[index]], newCount)
} else {
return obj[parts[index]]
}
}
return recursive(oai, 1)
}
module.exports = {
getAll: swaggerToHarList,
getEndpoint: createHar
}