openapi: remove swagger-node-express

This commit is contained in:
Viljami Kuosmanen 2020-03-29 16:39:45 +02:00 committed by muxator
parent 25e081ac89
commit f9d24f5a39
4 changed files with 204 additions and 460 deletions

View file

@ -4,7 +4,6 @@ const { promisify } = require('util');
const apiHandler = require('../../handler/APIHandler');
const settings = require('../../utils/Settings');
const { API } = require('./swagger');
const log4js = require('log4js');
const apiLogger = log4js.getLogger('API');
@ -12,12 +11,214 @@ const apiLogger = log4js.getLogger('API');
// https://github.com/OAI/OpenAPI-Specification/tree/master/schemas/v3.0
const OPENAPI_VERSION = '3.0.2'; // Swagger/OAS version
// We'll add some more info to the API methods
// operations
const API = {
// Group
group: {
create: {
func: 'createGroup',
description: 'creates a new group',
response: { groupID: { type: 'string' } },
},
createIfNotExistsFor: {
func: 'createGroupIfNotExistsFor',
description: 'this functions helps you to map your application group ids to Etherpad group ids',
response: { groupID: { type: 'string' } },
},
delete: {
func: 'deleteGroup',
description: 'deletes a group',
},
listPads: {
func: 'listPads',
description: 'returns all pads of this group',
response: { padIDs: { type: 'List', items: { type: 'string' } } },
},
createPad: {
func: 'createGroupPad',
description: 'creates a new pad in this group',
},
listSessions: {
func: 'listSessionsOfGroup',
description: '',
response: { sessions: { type: 'List', items: { type: 'SessionInfo' } } },
},
list: {
func: 'listAllGroups',
description: '',
response: { groupIDs: { type: 'List', items: { type: 'string' } } },
},
},
// Author
author: {
create: {
func: 'createAuthor',
description: 'creates a new author',
response: { authorID: { type: 'string' } },
},
createIfNotExistsFor: {
func: 'createAuthorIfNotExistsFor',
description: 'this functions helps you to map your application author ids to Etherpad author ids',
response: { authorID: { type: 'string' } },
},
listPads: {
func: 'listPadsOfAuthor',
description: 'returns an array of all pads this author contributed to',
response: { padIDs: { type: 'List', items: { type: 'string' } } },
},
listSessions: {
func: 'listSessionsOfAuthor',
description: 'returns all sessions of an author',
response: { sessions: { type: 'List', items: { type: 'SessionInfo' } } },
},
// We need an operation that return a UserInfo so it can be picked up by the codegen :(
getName: {
func: 'getAuthorName',
description: 'Returns the Author Name of the author',
response: { info: { type: 'UserInfo' } },
},
},
// Session
session: {
create: {
func: 'createSession',
description: 'creates a new session. validUntil is an unix timestamp in seconds',
response: { sessionID: { type: 'string' } },
},
delete: {
func: 'deleteSession',
description: 'deletes a session',
},
// We need an operation that returns a SessionInfo so it can be picked up by the codegen :(
info: {
func: 'getSessionInfo',
description: 'returns informations about a session',
response: { info: { type: 'SessionInfo' } },
},
},
// Pad
pad: {
listAll: {
func: 'listAllPads',
description: 'list all the pads',
response: { padIDs: { type: 'List', items: { type: 'string' } } },
},
createDiffHTML: {
func: 'createDiffHTML',
description: '',
response: {},
},
create: {
func: 'createPad',
description:
'creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad',
},
getText: {
func: 'getText',
description: 'returns the text of a pad',
response: { text: { type: 'string' } },
},
setText: {
func: 'setText',
description: 'sets the text of a pad',
},
getHTML: {
func: 'getHTML',
description: 'returns the text of a pad formatted as HTML',
response: { html: { type: 'string' } },
},
setHTML: {
func: 'setHTML',
description: 'sets the text of a pad with HTML',
},
getRevisionsCount: {
func: 'getRevisionsCount',
description: 'returns the number of revisions of this pad',
response: { revisions: { type: 'integer' } },
},
getLastEdited: {
func: 'getLastEdited',
description: 'returns the timestamp of the last revision of the pad',
response: { lastEdited: { type: 'integer' } },
},
delete: {
func: 'deletePad',
description: 'deletes a pad',
},
getReadOnlyID: {
func: 'getReadOnlyID',
description: 'returns the read only link of a pad',
response: { readOnlyID: { type: 'string' } },
},
setPublicStatus: {
func: 'setPublicStatus',
description: 'sets a boolean for the public status of a pad',
},
getPublicStatus: {
func: 'getPublicStatus',
description: 'return true of false',
response: { publicStatus: { type: 'boolean' } },
},
setPassword: {
func: 'setPassword',
description: 'returns ok or a error message',
},
isPasswordProtected: {
func: 'isPasswordProtected',
description: 'returns true or false',
response: { passwordProtection: { type: 'boolean' } },
},
authors: {
func: 'listAuthorsOfPad',
description: 'returns an array of authors who contributed to this pad',
response: { authorIDs: { type: 'List', items: { type: 'string' } } },
},
usersCount: {
func: 'padUsersCount',
description: 'returns the number of user that are currently editing this pad',
response: { padUsersCount: { type: 'integer' } },
},
users: {
func: 'padUsers',
description: 'returns the list of users that are currently editing this pad',
response: { padUsers: { type: 'List', items: { type: 'UserInfo' } } },
},
sendClientsMessage: {
func: 'sendClientsMessage',
description: 'sends a custom message of type msg to the pad',
},
checkToken: {
func: 'checkToken',
description: 'returns ok when the current api token is valid',
},
getChatHistory: {
func: 'getChatHistory',
description: 'returns the chat history',
response: { messages: { type: 'List', items: { type: 'Message' } } },
},
// We need an operation that returns a Message so it can be picked up by the codegen :(
getChatHead: {
func: 'getChatHead',
description: 'returns the chatHead (chat-message) of the pad',
response: { chatHead: { type: 'Message' } },
},
appendChatMessage: {
func: 'appendChatMessage',
description: 'appends a chat message',
},
},
};
// enum for two different styles of API paths used for etherpad
const APIPathStyle = {
FLAT: 'api', // flat paths e.g. /api/createGroup
REST: 'rest', // restful paths e.g. /rest/group/create
};
exports.APIPathStyle = APIPathStyle;
// helper to get api root
const getApiRootForVersion = (version, style = APIPathStyle.FLAT) => `/${style}/${version}`;
@ -205,6 +406,7 @@ exports.expressCreateServer = (_, args) => {
const api = new OpenAPIBackend({
apiRoot,
definition,
validate: false,
strict: true,
});

View file

@ -1,442 +0,0 @@
var express = require('express');
var apiHandler = require('../../handler/APIHandler');
var apiCaller = require('./apicalls').apiCaller;
var settings = require('../../utils/Settings');
var swaggerModels = {
models: {
SessionInfo: {
id: 'SessionInfo',
properties: {
id: {
type: 'string',
},
authorID: {
type: 'string',
},
groupID: {
type: 'string',
},
validUntil: {
type: 'integer',
},
},
},
UserInfo: {
id: 'UserInfo',
properties: {
id: {
type: 'string',
},
colorId: {
type: 'string',
},
name: {
type: 'string',
},
timestamp: {
type: 'integer',
},
},
},
Message: {
id: 'Message',
properties: {
text: {
type: 'string',
},
userId: {
type: 'string',
},
userName: {
type: 'string',
},
time: {
type: 'integer',
},
},
},
},
};
function sessionListResponseProcessor(res) {
if (res.data) {
var sessions = [];
for (var sessionId in res.data) {
var sessionInfo = res.data[sessionId];
sessionId['id'] = sessionId;
sessions.push(sessionInfo);
}
res.data = sessions;
}
return res;
}
// We'll add some more info to the API methods
var API = {
// Group
group: {
create: {
func: 'createGroup',
description: 'creates a new group',
response: { groupID: { type: 'string' } },
},
createIfNotExistsFor: {
func: 'createGroupIfNotExistsFor',
description: 'this functions helps you to map your application group ids to Etherpad group ids',
response: { groupID: { type: 'string' } },
},
delete: {
func: 'deleteGroup',
description: 'deletes a group',
},
listPads: {
func: 'listPads',
description: 'returns all pads of this group',
response: { padIDs: { type: 'List', items: { type: 'string' } } },
},
createPad: {
func: 'createGroupPad',
description: 'creates a new pad in this group',
},
listSessions: {
func: 'listSessionsOfGroup',
responseProcessor: sessionListResponseProcessor,
description: '',
response: { sessions: { type: 'List', items: { type: 'SessionInfo' } } },
},
list: {
func: 'listAllGroups',
description: '',
response: { groupIDs: { type: 'List', items: { type: 'string' } } },
},
},
// Author
author: {
create: {
func: 'createAuthor',
description: 'creates a new author',
response: { authorID: { type: 'string' } },
},
createIfNotExistsFor: {
func: 'createAuthorIfNotExistsFor',
description: 'this functions helps you to map your application author ids to Etherpad author ids',
response: { authorID: { type: 'string' } },
},
listPads: {
func: 'listPadsOfAuthor',
description: 'returns an array of all pads this author contributed to',
response: { padIDs: { type: 'List', items: { type: 'string' } } },
},
listSessions: {
func: 'listSessionsOfAuthor',
responseProcessor: sessionListResponseProcessor,
description: 'returns all sessions of an author',
response: { sessions: { type: 'List', items: { type: 'SessionInfo' } } },
},
// We need an operation that return a UserInfo so it can be picked up by the codegen :(
getName: {
func: 'getAuthorName',
description: 'Returns the Author Name of the author',
responseProcessor: function(response) {
if (response.data) {
response['info'] = { name: response.data.authorName };
delete response['data'];
}
},
response: { info: { type: 'UserInfo' } },
},
},
session: {
create: {
func: 'createSession',
description: 'creates a new session. validUntil is an unix timestamp in seconds',
response: { sessionID: { type: 'string' } },
},
delete: {
func: 'deleteSession',
description: 'deletes a session',
},
// We need an operation that returns a SessionInfo so it can be picked up by the codegen :(
info: {
func: 'getSessionInfo',
description: 'returns informations about a session',
responseProcessor: function(response) {
// move this to info
if (response.data) {
response['info'] = response.data;
delete response['data'];
}
},
response: { info: { type: 'SessionInfo' } },
},
},
pad: {
listAll: {
func: 'listAllPads',
description: 'list all the pads',
response: { padIDs: { type: 'List', items: { type: 'string' } } },
},
createDiffHTML: {
func: 'createDiffHTML',
description: '',
response: {},
},
create: {
func: 'createPad',
description:
'creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad',
},
getText: {
func: 'getText',
description: 'returns the text of a pad',
response: { text: { type: 'string' } },
},
setText: {
func: 'setText',
description: 'sets the text of a pad',
},
getHTML: {
func: 'getHTML',
description: 'returns the text of a pad formatted as HTML',
response: { html: { type: 'string' } },
},
setHTML: {
func: 'setHTML',
description: 'sets the text of a pad with HTML',
},
getRevisionsCount: {
func: 'getRevisionsCount',
description: 'returns the number of revisions of this pad',
response: { revisions: { type: 'integer' } },
},
getLastEdited: {
func: 'getLastEdited',
description: 'returns the timestamp of the last revision of the pad',
response: { lastEdited: { type: 'integer' } },
},
delete: {
func: 'deletePad',
description: 'deletes a pad',
},
getReadOnlyID: {
func: 'getReadOnlyID',
description: 'returns the read only link of a pad',
response: { readOnlyID: { type: 'string' } },
},
setPublicStatus: {
func: 'setPublicStatus',
description: 'sets a boolean for the public status of a pad',
},
getPublicStatus: {
func: 'getPublicStatus',
description: 'return true of false',
response: { publicStatus: { type: 'boolean' } },
},
setPassword: {
func: 'setPassword',
description: 'returns ok or a error message',
},
isPasswordProtected: {
func: 'isPasswordProtected',
description: 'returns true or false',
response: { passwordProtection: { type: 'boolean' } },
},
authors: {
func: 'listAuthorsOfPad',
description: 'returns an array of authors who contributed to this pad',
response: { authorIDs: { type: 'List', items: { type: 'string' } } },
},
usersCount: {
func: 'padUsersCount',
description: 'returns the number of user that are currently editing this pad',
response: { padUsersCount: { type: 'integer' } },
},
users: {
func: 'padUsers',
description: 'returns the list of users that are currently editing this pad',
response: { padUsers: { type: 'List', items: { type: 'UserInfo' } } },
},
sendClientsMessage: {
func: 'sendClientsMessage',
description: 'sends a custom message of type msg to the pad',
},
checkToken: {
func: 'checkToken',
description: 'returns ok when the current api token is valid',
},
getChatHistory: {
func: 'getChatHistory',
description: 'returns the chat history',
response: { messages: { type: 'List', items: { type: 'Message' } } },
},
// We need an operation that returns a Message so it can be picked up by the codegen :(
getChatHead: {
func: 'getChatHead',
description: 'returns the chatHead (chat-message) of the pad',
responseProcessor: function(response) {
// move this to info
if (response.data) {
response['chatHead'] = { time: response.data['chatHead'] };
delete response['data'];
}
},
response: { chatHead: { type: 'Message' } },
},
appendChatMessage: {
func: 'appendChatMessage',
description: 'appends a chat message',
},
},
};
exports.API = API;
function capitalise(string) {
return string.charAt(0).toUpperCase() + string.slice(1);
}
for (var resource in API) {
for (var func in API[resource]) {
// The base response model
var responseModel = {
properties: {
code: {
type: 'int',
},
message: {
type: 'string',
},
},
};
var responseModelId = 'Response';
// Add the data properties (if any) to the response
if (API[resource][func]['response']) {
// This is a specific response so let's set a new id
responseModelId = capitalise(resource) + capitalise(func) + 'Response';
for (var prop in API[resource][func]['response']) {
var propType = API[resource][func]['response'][prop];
responseModel['properties'][prop] = propType;
}
}
// Add the id
responseModel['id'] = responseModelId;
// Add this to the swagger models
swaggerModels['models'][responseModelId] = responseModel;
// Store the response model id
API[resource][func]['responseClass'] = responseModelId;
}
}
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) {
for (var version in apiHandler.version) {
var swagger = newSwagger();
var basePath = '/rest/' + version;
// Let's put this under /rest for now
var subpath = express();
args.app.use(basePath, subpath);
//hack!
var swagger_temp = swagger;
swagger = swagger.createNew(subpath);
swagger.params = swagger_temp.params;
swagger.queryParam = swagger_temp.queryParam;
swagger.pathParam = swagger_temp.pathParam;
swagger.bodyParam = swagger_temp.bodyParam;
swagger.formParam = swagger_temp.formParam;
swagger.headerParam = swagger_temp.headerParam;
swagger.error = swagger_temp.error;
//swagger.setAppHandler(subpath);
swagger.addModels(swaggerModels);
for (var resource in API) {
for (var funcName in API[resource]) {
var func = API[resource][funcName];
// get the api function
var apiFunc = apiHandler.version[version][func['func']];
// Skip this one if it does not exist in the version
if (!apiFunc) {
continue;
}
var swaggerFunc = {
spec: {
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"
if (response.data) {
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);
};
})(func['func'], func['responseProcessor']), // must use a closure here
};
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);
}
};

15
src/package-lock.json generated
View file

@ -7239,21 +7239,6 @@
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz",
"integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc="
},
"swagger-node-express": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/swagger-node-express/-/swagger-node-express-2.1.3.tgz",
"integrity": "sha1-Sx/ul24RKE0nZXWRGYCyJY43nas=",
"requires": {
"lodash": "1.3.1"
},
"dependencies": {
"lodash": {
"version": "1.3.1",
"resolved": "https://registry.npmjs.org/lodash/-/lodash-1.3.1.tgz",
"integrity": "sha1-pGY7U2hriV/wdOK6UE37dqjit3A="
}
}
},
"swagger-parser": {
"version": "9.0.1",
"resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-9.0.1.tgz",

View file

@ -58,7 +58,6 @@
"semver": "5.6.0",
"slide": "1.1.6",
"socket.io": "2.1.1",
"swagger-node-express": "2.1.3",
"tinycon": "0.0.1",
"ueberdb2": "0.4.3",
"uglify-js": "2.6.2",