mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-21 16:06:16 -04:00
Multiple REST endpoints (one per version)
This commit is contained in:
parent
8f279a6710
commit
a5987285e0
1 changed files with 123 additions and 107 deletions
|
@ -1,13 +1,9 @@
|
||||||
var log4js = require('log4js');
|
var log4js = require('log4js');
|
||||||
var express = require('express');
|
var express = require('express');
|
||||||
var swagger = require("swagger-node-express");
|
|
||||||
var apiHandler = require('../../handler/APIHandler');
|
var apiHandler = require('../../handler/APIHandler');
|
||||||
var apiCaller = require('./apicalls').apiCaller;
|
var apiCaller = require('./apicalls').apiCaller;
|
||||||
var settings = require("../../utils/Settings");
|
var settings = require("../../utils/Settings");
|
||||||
|
|
||||||
var versions = Object.keys(apiHandler.version)
|
|
||||||
var version = versions[versions.length - 1];
|
|
||||||
|
|
||||||
var swaggerModels = {
|
var swaggerModels = {
|
||||||
'models': {
|
'models': {
|
||||||
'SessionInfo' : {
|
'SessionInfo' : {
|
||||||
|
@ -177,7 +173,7 @@ var API = {
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"response": {"info":{"type":"SessionInfo"}}
|
"response": {"info":{"type":"SessionInfo"}}
|
||||||
},
|
}
|
||||||
},
|
},
|
||||||
"pad": {
|
"pad": {
|
||||||
"listAll" : {
|
"listAll" : {
|
||||||
|
@ -192,7 +188,7 @@ var API = {
|
||||||
},
|
},
|
||||||
"create" : {
|
"create" : {
|
||||||
"func" : "createPad",
|
"func" : "createPad",
|
||||||
"description": "creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad",
|
"description": "creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad"
|
||||||
},
|
},
|
||||||
"getText" : {
|
"getText" : {
|
||||||
"func" : "getText",
|
"func" : "getText",
|
||||||
|
@ -334,82 +330,102 @@ for (var resource in API) {
|
||||||
// Store the response model id
|
// Store the response model id
|
||||||
API[resource][func]["responseClass"] = responseModelId;
|
API[resource][func]["responseClass"] = responseModelId;
|
||||||
|
|
||||||
// get the api function
|
|
||||||
var apiFunc = apiHandler.version[version][API[resource][func]["func"]];
|
|
||||||
|
|
||||||
// Add the api function parameters
|
|
||||||
API[resource][func]["params"] = apiFunc.map( function(param) {
|
|
||||||
return swagger.queryParam(param, param, "string");
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function newSwagger() {
|
||||||
|
var swagger_module = require.resolve("swagger-node-express");
|
||||||
|
if (require.cache[swagger_module]) {
|
||||||
|
// delete the child modules from cache
|
||||||
|
require.cache[swagger_module].children.forEach(function(m) {delete require.cache[m.id];});
|
||||||
|
// delete the module from cache
|
||||||
|
delete require.cache[swagger_module];
|
||||||
|
}
|
||||||
|
return require("swagger-node-express");
|
||||||
|
}
|
||||||
|
|
||||||
exports.expressCreateServer = function (hook_name, args, cb) {
|
exports.expressCreateServer = function (hook_name, args, cb) {
|
||||||
|
|
||||||
// Let's put this under /rest for now
|
for (var version in apiHandler.version) {
|
||||||
var subpath = express();
|
|
||||||
|
|
||||||
args.app.use(express.bodyParser());
|
var swagger = newSwagger();
|
||||||
args.app.use("/rest", subpath);
|
var basePath = "/rest/" + version;
|
||||||
|
|
||||||
swagger.setAppHandler(subpath);
|
// Let's put this under /rest for now
|
||||||
|
var subpath = express();
|
||||||
|
|
||||||
swagger.addModels(swaggerModels);
|
args.app.use(express.bodyParser());
|
||||||
|
args.app.use(basePath, subpath);
|
||||||
|
|
||||||
for (var resource in API) {
|
swagger.setAppHandler(subpath);
|
||||||
|
|
||||||
for (var funcName in API[resource]) {
|
swagger.addModels(swaggerModels);
|
||||||
var func = API[resource][funcName];
|
|
||||||
|
|
||||||
var swaggerFunc = {
|
for (var resource in API) {
|
||||||
'spec': {
|
|
||||||
"description" : func["description"],
|
|
||||||
"path" : "/" + resource + "/" + funcName,
|
|
||||||
"summary" : funcName,
|
|
||||||
"nickname" : funcName,
|
|
||||||
"method": "GET",
|
|
||||||
"params" : func["params"],
|
|
||||||
"responseClass" : func["responseClass"]
|
|
||||||
},
|
|
||||||
'action': (function(func, responseProcessor) {
|
|
||||||
return function (req,res) {
|
|
||||||
req.params.version = version;
|
|
||||||
req.params.func = func; // call the api function
|
|
||||||
|
|
||||||
//wrap the send function so we can process the response
|
for (var funcName in API[resource]) {
|
||||||
res.__swagger_send = res.send;
|
var func = API[resource][funcName];
|
||||||
res.send = function (response) {
|
|
||||||
// ugly but we need to get this as json
|
// get the api function
|
||||||
response = JSON.parse(response);
|
var apiFunc = apiHandler.version[version][func["func"]];
|
||||||
// process the response if needed
|
|
||||||
if (responseProcessor) {
|
// Skip this one if it does not exist in the version
|
||||||
response = responseProcessor(response);
|
if(!apiFunc) {
|
||||||
}
|
continue;
|
||||||
// Let's move everything out of "data"
|
}
|
||||||
if (response.data) {
|
|
||||||
for(var prop in response.data) {
|
var swaggerFunc = {
|
||||||
response[prop] = response.data[prop];
|
'spec': {
|
||||||
delete response.data;
|
"description" : func["description"],
|
||||||
|
"path" : "/" + resource + "/" + funcName,
|
||||||
|
"summary" : funcName,
|
||||||
|
"nickname" : funcName,
|
||||||
|
"method": "GET",
|
||||||
|
"params" : apiFunc.map( function(param) {
|
||||||
|
return swagger.queryParam(param, param, "string");
|
||||||
|
}),
|
||||||
|
"responseClass" : func["responseClass"]
|
||||||
|
},
|
||||||
|
'action': (function(func, responseProcessor) {
|
||||||
|
return function (req,res) {
|
||||||
|
req.params.version = version;
|
||||||
|
req.params.func = func; // call the api function
|
||||||
|
|
||||||
|
//wrap the send function so we can process the response
|
||||||
|
res.__swagger_send = res.send;
|
||||||
|
res.send = function (response) {
|
||||||
|
// ugly but we need to get this as json
|
||||||
|
response = JSON.parse(response);
|
||||||
|
// process the response if needed
|
||||||
|
if (responseProcessor) {
|
||||||
|
response = responseProcessor(response);
|
||||||
}
|
}
|
||||||
}
|
// Let's move everything out of "data"
|
||||||
response = JSON.stringify(response);
|
if (response.data) {
|
||||||
res.__swagger_send(response);
|
for(var prop in response.data) {
|
||||||
}
|
response[prop] = response.data[prop];
|
||||||
|
delete response.data;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
response = JSON.stringify(response);
|
||||||
|
res.__swagger_send(response);
|
||||||
|
};
|
||||||
|
|
||||||
apiCaller(req, res, req.query);
|
apiCaller(req, res, req.query);
|
||||||
};
|
};
|
||||||
})(func["func"], func["responseProcessor"]) // must use a closure here
|
})(func["func"], func["responseProcessor"]) // must use a closure here
|
||||||
};
|
};
|
||||||
|
|
||||||
swagger.addGet(swaggerFunc);
|
swagger.addGet(swaggerFunc);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
swagger.setHeaders = function setHeaders(res) {
|
||||||
|
res.header('Access-Control-Allow-Origin', "*");
|
||||||
|
};
|
||||||
|
|
||||||
|
swagger.configureSwaggerPaths("", "/api" , "");
|
||||||
|
|
||||||
|
swagger.configure("http://" + settings.ip + ":" + settings.port + basePath, version);
|
||||||
}
|
}
|
||||||
|
};
|
||||||
swagger.setHeaders = function setHeaders(res) {
|
|
||||||
res.header('Access-Control-Allow-Origin', "*");
|
|
||||||
};
|
|
||||||
|
|
||||||
swagger.configureSwaggerPaths("", "/api" , "");
|
|
||||||
|
|
||||||
swagger.configure("http://" + settings.ip + ":" + settings.port + "/rest", version);
|
|
||||||
}
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue