/
apidocToSwagger.js
85 lines (75 loc) · 1.92 KB
/
apidocToSwagger.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
var _ = require('lodash');
var swagger = {
swagger : "2.0",
info : {},
paths : {}
};
function toSwagger(apidocJson, projectJson) {
swagger.info = addInfo(projectJson);
swagger.paths = extractPaths(apidocJson);
return swagger;
}
function addInfo(projectJson) {
var info = {};
info["title"] = projectJson.title;
info["version"] = projectJson.version;
info["description"] = projectJson.description;
return info;
}
function extractPaths(apidocJson){
var apiPaths = groupByUrl(apidocJson);
var paths = {};
for (var i = 0; i < apiPaths.length; i++) {
paths[apiPaths[i].url] = extractVerbs(apiPaths[i].verbs);
}
return paths;
}
function extractVerbs(verbs){
var pathItemObject = {};
for (var i = 0; i < verbs.length; i++) {
//TODO: if there are multiple version of documentation for same api/verb pick latest!
pathItemObject[verbs[i].type] = createOperationObject(verbs[i]);
}
return pathItemObject;
}
function groupByUrl(apidocJson) {
return _.chain(apidocJson)
.groupBy("url")
.pairs()
.map(function (element) {
return _.object(_.zip(["url", "verbs"], element));
})
.value();
}
function createOperationObject(verb) {
var operationObject = {
description : verb.title,
summary : verb.description,
tags : [verb.group],
parameters : verb.parameter ? createParameters(verb.parameter): {}
};
return operationObject;
}
function createParameters(apiParameters) {
var parameterArray = [];
var parameters = [];
for (field in apiParameters.fields) {
if (Array.isArray(apiParameters.fields[field])) {
parameterArray = apiParameters.fields[field];
}
}
for (var i = 0; i < parameterArray.length; i++) {
var parameter = {
name : parameterArray[i].field,
in : "query",
description : parameterArray[i].description,
required : !parameterArray[i].optional,
type : parameterArray[i].type,
};
parameters.push(parameter);
}
return parameters;
}
module.exports = {
toSwagger: toSwagger
};