kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated link

Browse Source
This commit is contained in:
Tony Tam
2014-09-18 21:04:24 -07:00
parent b9c631e09e
commit 4e508c0a1e
4 changed files with 3120 additions and 3096 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dist/index.html vendored
View File

@@ -26,7 +26,7 @@
<script type="text/javascript">
$(function () {
window.swaggerUi = new SwaggerUi({
url: "http://petstore.swagger.wordnik.com/api/api-docs",
url: "http://petstore.swagger.wordnik.com/v2/swagger.json",
dom_id: "swagger-ui-container",
supportedSubmitMethods: ['get', 'post', 'put', 'delete'],
onComplete: function(swaggerApi, swaggerUi){

72
dist/lib/swagger.js vendored
View File

@@ -1,5 +1,7 @@
// swagger.js
// version 2.0.39
// version 2.0.41
(function () {
var __bind = function (fn, me) {
return function () {
@@ -7,7 +9,7 @@ var __bind = function(fn, me){
};
};
log = function(){
var log = function () {
log.history = log.history || [];
log.history.push(arguments);
if (this.console) {
@@ -16,12 +18,12 @@ log = function(){
};
// if you want to apply conditional formatting of parameter values
parameterMacro = function(value) {
var parameterMacro = function (value) {
return value;
}
// if you want to apply conditional formatting of model property values
modelPropertyMacro = function(value) {
var modelPropertyMacro = function (value) {
return value;
}
@@ -99,6 +101,7 @@ var SwaggerApi = function(url, options) {
this.info = null;
this.useJQuery = false;
this.modelsArray = [];
this.isValid;
options = (options || {});
if (url)
@@ -201,18 +204,19 @@ SwaggerApi.prototype.buildFromSpec = function(response) {
if (isApi) {
var newName = response.resourcePath.replace(/\//g, '');
this.resourcePath = response.resourcePath;
res = new SwaggerResource(response, this);
var res = new SwaggerResource(response, this);
this.apis[newName] = res;
this.apisArray.push(res);
} else {
var k;
for (k = 0; k < response.apis.length; k++) {
var resource = response.apis[k];
res = new SwaggerResource(resource, this);
var res = new SwaggerResource(resource, this);
this.apis[res.name] = res;
this.apisArray.push(res);
}
}
this.isValid = true;
if (this.success) {
this.success();
}
@@ -255,11 +259,12 @@ SwaggerApi.prototype.buildFrom1_1Spec = function(response) {
} else {
for (k = 0; k < response.apis.length; k++) {
resource = response.apis[k];
res = new SwaggerResource(resource, this);
var res = new SwaggerResource(resource, this);
this.apis[res.name] = res;
this.apisArray.push(res);
}
}
this.isValid = true;
if (this.success) {
this.success();
}
@@ -336,8 +341,8 @@ var SwaggerResource = function(resourceObj, api) {
var _this = this;
this.api = api;
this.api = this.api;
consumes = (this.consumes | []);
produces = (this.produces | []);
var consumes = (this.consumes | []);
var produces = (this.produces | []);
this.path = this.api.resourcePath != null ? this.api.resourcePath : resourceObj.path;
this.description = resourceObj.description;
@@ -363,7 +368,7 @@ var SwaggerResource = function(resourceObj, api) {
this.url = this.api.basePath + this.path.replace('{format}', 'json');
}
this.api.progress('fetching resource ' + this.name + ': ' + this.url);
obj = {
var obj = {
url: this.url,
method: "get",
useJQuery: this.useJQuery,
@@ -445,7 +450,7 @@ SwaggerResource.prototype.addModels = function(models) {
}
var output = [];
for (var i = 0; i < this.modelsArray.length; i++) {
model = this.modelsArray[i];
var model = this.modelsArray[i];
output.push(model.setReferencedModels(this.models));
}
return output;
@@ -454,9 +459,9 @@ SwaggerResource.prototype.addModels = function(models) {
SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes, produces) {
if (ops) {
output = [];
var output = [];
for (var i = 0; i < ops.length; i++) {
o = ops[i];
var o = ops[i];
consumes = this.consumes;
produces = this.produces;
if (o.consumes != null)
@@ -468,7 +473,7 @@ SwaggerResource.prototype.addOperations = function(resource_path, ops, consumes,
produces = o.produces;
else
produces = this.produces;
type = (o.type||o.responseClass);
var type = (o.type || o.responseClass);
if (type === "array") {
ref = null;
@@ -476,8 +481,8 @@ SwaggerResource.prototype.addOperations = function(resource_path, ops, consumes,
ref = o.items["type"] || o.items["$ref"];
type = "array[" + ref + "]";
}
responseMessages = o.responseMessages;
method = o.method;
var responseMessages = o.responseMessages;
var method = o.method;
if (o.httpMethod) {
method = o.httpMethod;
}
@@ -493,7 +498,7 @@ SwaggerResource.prototype.addOperations = function(resource_path, ops, consumes,
}
}
o.nickname = this.sanitize(o.nickname);
op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations);
var op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations);
this.operations[op.nickname] = op;
output.push(this.operationsArray.push(op));
}
@@ -539,7 +544,7 @@ var SwaggerModel = function(modelName, obj) {
}
}
}
prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName]);
var prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName]);
this.properties.push(prop);
}
}
@@ -562,7 +567,7 @@ SwaggerModel.prototype.setReferencedModels = function(allModels) {
SwaggerModel.prototype.getMockSignature = function (modelsToIgnore) {
var propertiesStr = [];
for (var i = 0; i < this.properties.length; i++) {
prop = this.properties[i];
var prop = this.properties[i];
propertiesStr.push(prop.toString());
}
@@ -577,7 +582,7 @@ SwaggerModel.prototype.getMockSignature = function(modelsToIgnore) {
modelsToIgnore.push(this.name);
for (var i = 0; i < this.properties.length; i++) {
prop = this.properties[i];
var prop = this.properties[i];
if ((prop.refModel != null) && modelsToIgnore.indexOf(prop.refModel.name) === -1) {
returnVal = returnVal + ('<br>' + prop.refModel.getMockSignature(modelsToIgnore));
}
@@ -594,7 +599,7 @@ SwaggerModel.prototype.createJSONSample = function(modelsToIgnore) {
var modelsToIgnore = (modelsToIgnore || [])
modelsToIgnore.push(this.name);
for (var i = 0; i < this.properties.length; i++) {
prop = this.properties[i];
var prop = this.properties[i];
result[prop.name] = prop.getSampleValue(modelsToIgnore);
}
modelsToIgnore.pop(this.name);
@@ -636,7 +641,7 @@ var SwaggerModelProperty = function(name, obj) {
SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) {
var result;
if ((this.refModel != null) && (modelsToIgnore.indexOf(prop.refModel.name) === -1)) {
if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) {
result = this.refModel.createJSONSample(modelsToIgnore);
} else {
if (this.isCollection) {
@@ -704,8 +709,10 @@ var SwaggerOperation = function(nickname, path, method, parameters, summary, not
this.authorizations = authorizations;
this["do"] = __bind(this["do"], this);
if (errors.length > 0)
if (errors.length > 0) {
console.error('SwaggerOperation errors', errors, arguments);
this.resource.api.fail(errors);
}
this.path = this.path.replace('{format}', 'json');
this.method = this.method.toLowerCase();
@@ -907,7 +914,7 @@ SwaggerOperation.prototype["do"] = function(args, opts, callback, error) {
if (possibleParams) {
var key;
for (key in possibleParams) {
value = possibleParams[key];
var value = possibleParams[key];
if (args[value.name]) {
params[value.name] = args[value.name];
}
@@ -954,7 +961,7 @@ SwaggerOperation.prototype.urlify = function(args) {
if (param.paramType === 'path') {
if (args[param.name]) {
// apply path params and remove from args
var reg = new RegExp('\{' + param.name + '[^\}]*\}', 'gi');
var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/|$))', 'gi');
url = url.replace(reg, this.encodePathParam(args[param.name]));
delete args[param.name];
}
@@ -1135,7 +1142,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
if (headers["Content-Type"].indexOf("application/x-www-form-urlencoded") === 0) {
var encoded = "";
var key;
var key, value;
for (key in values) {
value = this.params[key];
if (typeof value !== 'undefined') {
@@ -1150,7 +1157,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
// encode the body for form submits
var data = "";
var boundary = "----SwaggerFormBoundary" + Date.now();
var key;
var key, value;
for (key in values) {
value = this.params[key];
if (typeof value !== 'undefined') {
@@ -1166,6 +1173,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
}
}
var obj;
if (!((this.headers != null) && (this.headers.mock != null))) {
obj = {
url: this.url,
@@ -1194,7 +1202,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
} else {
e = exports;
}
status = e.authorizations.apply(obj, this.operation.authorizations);
var status = e.authorizations.apply(obj, this.operation.authorizations);
if (opts.mock == null) {
if (status !== false) {
new SwaggerHttp().execute(obj);
@@ -1205,6 +1213,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
return obj;
}
}
return obj;
};
SwaggerRequest.prototype.setHeaders = function (params, operation) {
@@ -1500,7 +1509,7 @@ ShredHttpClient.prototype.execute = function(obj) {
return out;
};
res = {
var res = {
error: function (response) {
if (obj)
return cb.error(transform(response));
@@ -1547,7 +1556,7 @@ SwaggerAuthorizations.prototype.remove = function(name) {
SwaggerAuthorizations.prototype.apply = function (obj, authorizations) {
var status = null;
var key;
var key, value, result;
// if the "authorizations" key is undefined, or has an empty array, add all keys
if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) {
@@ -1651,3 +1660,6 @@ e.SwaggerModel = SwaggerModel;
e.SwaggerModelProperty = SwaggerModelProperty;
e.SwaggerResource = SwaggerResource;
e.SwaggerApi = SwaggerApi;
e.log = log;
})();

72
lib/swagger.js
View File

@@ -1,5 +1,7 @@
// swagger.js
// version 2.0.39
// version 2.0.41
(function () {
var __bind = function (fn, me) {
return function () {
@@ -7,7 +9,7 @@ var __bind = function(fn, me){
};
};
log = function(){
var log = function () {
log.history = log.history || [];
log.history.push(arguments);
if (this.console) {
@@ -16,12 +18,12 @@ log = function(){
};
// if you want to apply conditional formatting of parameter values
parameterMacro = function(value) {
var parameterMacro = function (value) {
return value;
}
// if you want to apply conditional formatting of model property values
modelPropertyMacro = function(value) {
var modelPropertyMacro = function (value) {
return value;
}
@@ -99,6 +101,7 @@ var SwaggerApi = function(url, options) {
this.info = null;
this.useJQuery = false;
this.modelsArray = [];
this.isValid;
options = (options || {});
if (url)
@@ -201,18 +204,19 @@ SwaggerApi.prototype.buildFromSpec = function(response) {
if (isApi) {
var newName = response.resourcePath.replace(/\//g, '');
this.resourcePath = response.resourcePath;
res = new SwaggerResource(response, this);
var res = new SwaggerResource(response, this);
this.apis[newName] = res;
this.apisArray.push(res);
} else {
var k;
for (k = 0; k < response.apis.length; k++) {
var resource = response.apis[k];
res = new SwaggerResource(resource, this);
var res = new SwaggerResource(resource, this);
this.apis[res.name] = res;
this.apisArray.push(res);
}
}
this.isValid = true;
if (this.success) {
this.success();
}
@@ -255,11 +259,12 @@ SwaggerApi.prototype.buildFrom1_1Spec = function(response) {
} else {
for (k = 0; k < response.apis.length; k++) {
resource = response.apis[k];
res = new SwaggerResource(resource, this);
var res = new SwaggerResource(resource, this);
this.apis[res.name] = res;
this.apisArray.push(res);
}
}
this.isValid = true;
if (this.success) {
this.success();
}
@@ -336,8 +341,8 @@ var SwaggerResource = function(resourceObj, api) {
var _this = this;
this.api = api;
this.api = this.api;
consumes = (this.consumes | []);
produces = (this.produces | []);
var consumes = (this.consumes | []);
var produces = (this.produces | []);
this.path = this.api.resourcePath != null ? this.api.resourcePath : resourceObj.path;
this.description = resourceObj.description;
@@ -363,7 +368,7 @@ var SwaggerResource = function(resourceObj, api) {
this.url = this.api.basePath + this.path.replace('{format}', 'json');
}
this.api.progress('fetching resource ' + this.name + ': ' + this.url);
obj = {
var obj = {
url: this.url,
method: "get",
useJQuery: this.useJQuery,
@@ -445,7 +450,7 @@ SwaggerResource.prototype.addModels = function(models) {
}
var output = [];
for (var i = 0; i < this.modelsArray.length; i++) {
model = this.modelsArray[i];
var model = this.modelsArray[i];
output.push(model.setReferencedModels(this.models));
}
return output;
@@ -454,9 +459,9 @@ SwaggerResource.prototype.addModels = function(models) {
SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes, produces) {
if (ops) {
output = [];
var output = [];
for (var i = 0; i < ops.length; i++) {
o = ops[i];
var o = ops[i];
consumes = this.consumes;
produces = this.produces;
if (o.consumes != null)
@@ -468,7 +473,7 @@ SwaggerResource.prototype.addOperations = function(resource_path, ops, consumes,
produces = o.produces;
else
produces = this.produces;
type = (o.type||o.responseClass);
var type = (o.type || o.responseClass);
if (type === "array") {
ref = null;
@@ -476,8 +481,8 @@ SwaggerResource.prototype.addOperations = function(resource_path, ops, consumes,
ref = o.items["type"] || o.items["$ref"];
type = "array[" + ref + "]";
}
responseMessages = o.responseMessages;
method = o.method;
var responseMessages = o.responseMessages;
var method = o.method;
if (o.httpMethod) {
method = o.httpMethod;
}
@@ -493,7 +498,7 @@ SwaggerResource.prototype.addOperations = function(resource_path, ops, consumes,
}
}
o.nickname = this.sanitize(o.nickname);
op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations);
var op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations);
this.operations[op.nickname] = op;
output.push(this.operationsArray.push(op));
}
@@ -539,7 +544,7 @@ var SwaggerModel = function(modelName, obj) {
}
}
}
prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName]);
var prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName]);
this.properties.push(prop);
}
}
@@ -562,7 +567,7 @@ SwaggerModel.prototype.setReferencedModels = function(allModels) {
SwaggerModel.prototype.getMockSignature = function (modelsToIgnore) {
var propertiesStr = [];
for (var i = 0; i < this.properties.length; i++) {
prop = this.properties[i];
var prop = this.properties[i];
propertiesStr.push(prop.toString());
}
@@ -577,7 +582,7 @@ SwaggerModel.prototype.getMockSignature = function(modelsToIgnore) {
modelsToIgnore.push(this.name);
for (var i = 0; i < this.properties.length; i++) {
prop = this.properties[i];
var prop = this.properties[i];
if ((prop.refModel != null) && modelsToIgnore.indexOf(prop.refModel.name) === -1) {
returnVal = returnVal + ('<br>' + prop.refModel.getMockSignature(modelsToIgnore));
}
@@ -594,7 +599,7 @@ SwaggerModel.prototype.createJSONSample = function(modelsToIgnore) {
var modelsToIgnore = (modelsToIgnore || [])
modelsToIgnore.push(this.name);
for (var i = 0; i < this.properties.length; i++) {
prop = this.properties[i];
var prop = this.properties[i];
result[prop.name] = prop.getSampleValue(modelsToIgnore);
}
modelsToIgnore.pop(this.name);
@@ -636,7 +641,7 @@ var SwaggerModelProperty = function(name, obj) {
SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) {
var result;
if ((this.refModel != null) && (modelsToIgnore.indexOf(prop.refModel.name) === -1)) {
if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) {
result = this.refModel.createJSONSample(modelsToIgnore);
} else {
if (this.isCollection) {
@@ -704,8 +709,10 @@ var SwaggerOperation = function(nickname, path, method, parameters, summary, not
this.authorizations = authorizations;
this["do"] = __bind(this["do"], this);
if (errors.length > 0)
if (errors.length > 0) {
console.error('SwaggerOperation errors', errors, arguments);
this.resource.api.fail(errors);
}
this.path = this.path.replace('{format}', 'json');
this.method = this.method.toLowerCase();
@@ -907,7 +914,7 @@ SwaggerOperation.prototype["do"] = function(args, opts, callback, error) {
if (possibleParams) {
var key;
for (key in possibleParams) {
value = possibleParams[key];
var value = possibleParams[key];
if (args[value.name]) {
params[value.name] = args[value.name];
}
@@ -954,7 +961,7 @@ SwaggerOperation.prototype.urlify = function(args) {
if (param.paramType === 'path') {
if (args[param.name]) {
// apply path params and remove from args
var reg = new RegExp('\{' + param.name + '[^\}]*\}', 'gi');
var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/|$))', 'gi');
url = url.replace(reg, this.encodePathParam(args[param.name]));
delete args[param.name];
}
@@ -1135,7 +1142,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
if (headers["Content-Type"].indexOf("application/x-www-form-urlencoded") === 0) {
var encoded = "";
var key;
var key, value;
for (key in values) {
value = this.params[key];
if (typeof value !== 'undefined') {
@@ -1150,7 +1157,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
// encode the body for form submits
var data = "";
var boundary = "----SwaggerFormBoundary" + Date.now();
var key;
var key, value;
for (key in values) {
value = this.params[key];
if (typeof value !== 'undefined') {
@@ -1166,6 +1173,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
}
}
var obj;
if (!((this.headers != null) && (this.headers.mock != null))) {
obj = {
url: this.url,
@@ -1194,7 +1202,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
} else {
e = exports;
}
status = e.authorizations.apply(obj, this.operation.authorizations);
var status = e.authorizations.apply(obj, this.operation.authorizations);
if (opts.mock == null) {
if (status !== false) {
new SwaggerHttp().execute(obj);
@@ -1205,6 +1213,7 @@ var SwaggerRequest = function(type, url, params, opts, successCallback, errorCal
return obj;
}
}
return obj;
};
SwaggerRequest.prototype.setHeaders = function (params, operation) {
@@ -1500,7 +1509,7 @@ ShredHttpClient.prototype.execute = function(obj) {
return out;
};
res = {
var res = {
error: function (response) {
if (obj)
return cb.error(transform(response));
@@ -1547,7 +1556,7 @@ SwaggerAuthorizations.prototype.remove = function(name) {
SwaggerAuthorizations.prototype.apply = function (obj, authorizations) {
var status = null;
var key;
var key, value, result;
// if the "authorizations" key is undefined, or has an empty array, add all keys
if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) {
@@ -1651,3 +1660,6 @@ e.SwaggerModel = SwaggerModel;
e.SwaggerModelProperty = SwaggerModelProperty;
e.SwaggerResource = SwaggerResource;
e.SwaggerApi = SwaggerApi;
e.log = log;
})();

2
src/main/html/index.html
View File

@@ -26,7 +26,7 @@
<script type="text/javascript">
$(function () {
window.swaggerUi = new SwaggerUi({
url: "http://petstore.swagger.wordnik.com/api/api-docs",
url: "http://petstore.swagger.wordnik.com/v2/swagger.json",
dom_id: "swagger-ui-container",
supportedSubmitMethods: ['get', 'post', 'put', 'delete'],
onComplete: function(swaggerApi, swaggerUi){