mirror of https://gitee.com/bigwinds/arangodb
97 lines
2.7 KiB
JavaScript
97 lines
2.7 KiB
JavaScript
'use strict';
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Foxx Swagger documentation
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2013 triagens GmbH, Cologne, Germany
|
|
///
|
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
|
/// you may not use this file except in compliance with the License.
|
|
/// You may obtain a copy of the License at
|
|
///
|
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
|
///
|
|
/// Unless required by applicable law or agreed to in writing, software
|
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
/// See the License for the specific language governing permissions and
|
|
/// limitations under the License.
|
|
///
|
|
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
|
|
///
|
|
/// @author Michael Hackstein
|
|
/// @author Copyright 2015, ArangoDB GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
var _ = require("lodash");
|
|
var internal = require("internal");
|
|
|
|
// Wraps the docs object of a route to add swagger compatible documentation
|
|
var SwaggerDocs = function (docs, models) {
|
|
this.docs = docs;
|
|
this.models = models;
|
|
};
|
|
|
|
SwaggerDocs.prototype.addPathParam = function (paramName, description, dataType, required) {
|
|
this.docs.parameters.push({
|
|
paramType: "path",
|
|
name: paramName,
|
|
description: description,
|
|
dataType: dataType,
|
|
required: required
|
|
});
|
|
};
|
|
|
|
SwaggerDocs.prototype.addQueryParam = function (paramName, description, dataType, required, allowMultiple) {
|
|
this.docs.parameters.push({
|
|
paramType: "query",
|
|
name: paramName,
|
|
description: description,
|
|
dataType: dataType,
|
|
required: required,
|
|
allowMultiple: allowMultiple
|
|
});
|
|
};
|
|
|
|
SwaggerDocs.prototype.addBodyParam = function (paramName, description, jsonSchema) {
|
|
|
|
var token = internal.genRandomAlphaNumbers(32);
|
|
while (this.models[token]) {
|
|
// Brute-force against random collisions
|
|
token = internal.genRandomAlphaNumbers(32);
|
|
}
|
|
this.models[token] = jsonSchema;
|
|
delete jsonSchema.id;
|
|
|
|
var param = _.find(this.docs.parameters, function (parameter) {
|
|
return parameter.name === 'undocumented body';
|
|
});
|
|
|
|
if (_.isUndefined(param)) {
|
|
this.docs.parameters.push({
|
|
name: paramName,
|
|
paramType: "body",
|
|
description: description,
|
|
dataType: token
|
|
});
|
|
} else {
|
|
param.name = paramName;
|
|
param.description = description;
|
|
param.dataType = token;
|
|
}
|
|
};
|
|
|
|
SwaggerDocs.prototype.addSummary = function (summary) {
|
|
this.docs.summary = summary;
|
|
};
|
|
|
|
SwaggerDocs.prototype.addNotes = function (notes) {
|
|
this.docs.notes = notes;
|
|
};
|
|
|
|
exports.Docs = SwaggerDocs;
|