forked from apigee-127/swagger-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhelpers.js
More file actions
121 lines (105 loc) · 3.83 KB
/
Copy pathhelpers.js
File metadata and controls
121 lines (105 loc) · 3.83 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
/*
* The MIT License (MIT)
*
* Copyright (c) 2014 Apigee Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
'use strict';
var _ = {
isUndefined: require('lodash.isundefined')
};
var parseurl = require('parseurl');
var specCache = {};
/**
* Returns an Express style path for the Swagger path.
*
* @param {string} [basePath] - The Swagger API base path
* @param {string} apiPath - The Swagger API path
*
* @returns the Express equivalent path
*/
module.exports.expressStylePath = function expressStylePath (basePath, apiPath) {
basePath = parseurl({url: basePath || '/'}).pathname || '/';
// Make sure the base path starts with '/'
if (basePath.charAt(0) !== '/') {
basePath = '/' + basePath;
}
// Make sure the base path ends with '/'
if (basePath.charAt(basePath.length - 1) !== '/') {
basePath = basePath + '/';
}
// Make sure the api path does not start with '/' since the base path will end with '/'
if (apiPath.charAt(0) === '/') {
apiPath = apiPath.substring(1);
}
// Replace Swagger syntax for path parameters with Express' version (All Swagger path parameters are required)
return (basePath + apiPath).replace(/{/g, ':').replace(/}/g, '');
};
/**
* Returns the proper specification based on the human readable version.
*
* @param {string} version - The human readable Swagger version (Ex: 1.2)
*
* @returns the corresponding Swagger Specification object or undefined if there is none
*/
module.exports.getSpec = function getSpec (version) {
var spec = specCache[version];
if (_.isUndefined(spec)) {
switch (version) {
case '1.2':
spec = require('../lib/specs').v1_2; // jshint ignore:line
break;
case '2.0':
spec = require('../lib/specs').v2_0; // jshint ignore:line
break;
}
}
return spec;
};
/**
* Takes a reference and creates a fully qualified JSON pointer from it. (2.0 only)
*
* If the passed in reference is fully qualified, it is returned as-is. Otherwise, the reference will have
* '#/definitions/' prepended to it to make it fully qualified since these 'relative' references are only allowed for
* model definitions.
*
* @param {string} ref - The relative or fully qualified reference
*
* @returns the corresponding JSON pointer for the reference
*/
module.exports.refToJsonPointer = function refToJsonPointer (ref) {
if (ref.charAt(0) !== '#') {
ref = '#/definitions/' + ref;
}
return ref;
};
/**
* Takes an array of path segments and creates a JSON pointer from it. (2.0 only)
*
* @param {string[]} path - The path segments
*
* @returns a JSON pointer for the reference denoted by the path segments
*/
module.exports.toJsonPointer = function toJsonPointer (path) {
// http://tools.ietf.org/html/rfc6901#section-4
return '#/' + path.map(function (part) {
return part.replace(/\//g, '~1');
}).join('/');
};