mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-21 16:06:16 -04:00
openapi: implement API handler with openapi-backend
- Tests pass ✅
- Added openapi-backend hook
- Generating OpenAPI v3 definitions for each API version
- Definitions served /api/openapi.json /api/{version}/openapi.json
This commit is contained in:
Viljami Kuosmanen
muxator
parent
dbab4ad13a
commit
25e081ac89
6 changed files with 680 additions and 328 deletions
255
src/node/hooks/express/openapi.js
Normal file
255
src/node/hooks/express/openapi.js
Normal file
|
|
@ -0,0 +1,255 @@
|
|||
const OpenAPIBackend = require('openapi-backend').default;
|
||||
const formidable = require('formidable');
|
||||
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');
|
||||
|
||||
// https://github.com/OAI/OpenAPI-Specification/tree/master/schemas/v3.0
|
||||
const OPENAPI_VERSION = '3.0.2'; // Swagger/OAS version
|
||||
|
||||
// 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}`;
|
||||
|
||||
// helper to generate an OpenAPI server object when serving definitions
|
||||
const generateServerForApiVersion = (apiRoot, req) => ({
|
||||
url: `${settings.ssl ? 'https' : 'http'}://${req.headers.host}${apiRoot}`,
|
||||
});
|
||||
|
||||
const defaultResponses = {
|
||||
200: {
|
||||
description: 'ok',
|
||||
},
|
||||
};
|
||||
|
||||
// convert to a flat list of OAS Operation objects
|
||||
const operations = [];
|
||||
for (const resource in API) {
|
||||
for (const action in API[resource]) {
|
||||
const { func: operationId, description, response } = API[resource][action];
|
||||
const operation = {
|
||||
operationId,
|
||||
summary: description,
|
||||
responses: defaultResponses,
|
||||
tags: [resource],
|
||||
_restPath: `/${resource}/${action}`,
|
||||
};
|
||||
operations[operationId] = operation;
|
||||
}
|
||||
}
|
||||
|
||||
const generateDefinitionForVersion = (version, style = APIPathStyle.FLAT) => {
|
||||
const definition = {
|
||||
openapi: OPENAPI_VERSION,
|
||||
info: {
|
||||
title: 'Etherpad API',
|
||||
description:
|
||||
'Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.',
|
||||
version,
|
||||
},
|
||||
paths: {},
|
||||
components: {
|
||||
responses: {},
|
||||
parameters: {},
|
||||
schemas: {
|
||||
SessionInfo: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'string',
|
||||
},
|
||||
authorID: {
|
||||
type: 'string',
|
||||
},
|
||||
groupID: {
|
||||
type: 'string',
|
||||
},
|
||||
validUntil: {
|
||||
type: 'integer',
|
||||
},
|
||||
},
|
||||
},
|
||||
UserInfo: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'string',
|
||||
},
|
||||
colorId: {
|
||||
type: 'string',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
},
|
||||
timestamp: {
|
||||
type: 'integer',
|
||||
},
|
||||
},
|
||||
},
|
||||
Message: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
text: {
|
||||
type: 'string',
|
||||
},
|
||||
userId: {
|
||||
type: 'string',
|
||||
},
|
||||
userName: {
|
||||
type: 'string',
|
||||
},
|
||||
time: {
|
||||
type: 'integer',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
securitySchemes: {
|
||||
ApiKey: {
|
||||
type: 'apiKey',
|
||||
in: 'query',
|
||||
name: 'apikey',
|
||||
},
|
||||
},
|
||||
},
|
||||
security: [{ ApiKey: [] }],
|
||||
};
|
||||
|
||||
// build operations
|
||||
for (const funcName in apiHandler.version[version]) {
|
||||
let operation = {};
|
||||
if (operations[funcName]) {
|
||||
operation = { ...operations[funcName] };
|
||||
} else {
|
||||
// console.warn(`No operation found for function: ${funcName}`);
|
||||
operation = {
|
||||
operationId: funcName,
|
||||
responses: defaultResponses,
|
||||
};
|
||||
}
|
||||
|
||||
// set parameters
|
||||
operation.parameters = operation.parameters || [];
|
||||
for (const paramName of apiHandler.version[version][funcName]) {
|
||||
operation.parameters.push({ $ref: `#/components/parameters/${paramName}` });
|
||||
if (!definition.components.parameters[paramName]) {
|
||||
definition.components.parameters[paramName] = {
|
||||
name: paramName,
|
||||
in: 'query',
|
||||
schema: {
|
||||
type: 'string',
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// set path
|
||||
let path = `/${operation.operationId}`; // APIPathStyle.FLAT
|
||||
if (style === APIPathStyle.REST && operation._restPath) {
|
||||
path = operation._restPath;
|
||||
}
|
||||
delete operation._restPath;
|
||||
|
||||
// add to definition
|
||||
// NOTE: It may be confusing that every operation can be called with both GET and POST
|
||||
definition.paths[path] = {
|
||||
get: {
|
||||
...operation,
|
||||
operationId: `${operation.operationId}UsingGET`,
|
||||
},
|
||||
post: {
|
||||
...operation,
|
||||
operationId: `${operation.operationId}UsingPOST`,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
return definition;
|
||||
};
|
||||
|
||||
exports.expressCreateServer = (_, args) => {
|
||||
const { app } = args;
|
||||
|
||||
for (const version in apiHandler.version) {
|
||||
// create two different styles of api: flat + rest
|
||||
for (const style of [APIPathStyle.FLAT, APIPathStyle.REST]) {
|
||||
const apiRoot = getApiRootForVersion(version, style);
|
||||
|
||||
// generate openapi definition for this API version
|
||||
const definition = generateDefinitionForVersion(version, style);
|
||||
|
||||
// serve openapi definition file
|
||||
app.get(`${apiRoot}/openapi.json`, (req, res) => {
|
||||
res.json({ ...definition, servers: [generateServerForApiVersion(apiRoot, req)] });
|
||||
});
|
||||
|
||||
// serve latest openapi definition file under /api/openapi.json
|
||||
if (version === apiHandler.latestApiVersion) {
|
||||
app.get(`/${style}/openapi.json`, (req, res) => {
|
||||
res.json({ ...definition, servers: [generateServerForApiVersion(apiRoot, req)] });
|
||||
});
|
||||
}
|
||||
|
||||
// build openapi-backend instance for this api version
|
||||
const api = new OpenAPIBackend({
|
||||
apiRoot,
|
||||
definition,
|
||||
strict: true,
|
||||
});
|
||||
|
||||
// register default handlers
|
||||
api.register({
|
||||
notFound: (c, req, res) => {
|
||||
res.statusCode = 404;
|
||||
res.send({ code: 3, message: 'no such function', data: null });
|
||||
},
|
||||
notImplemented: (c, req, res) => {
|
||||
res.statusCode = 501;
|
||||
res.send({ code: 3, message: 'not implemented', data: null });
|
||||
},
|
||||
});
|
||||
|
||||
// register operation handlers (calls apiHandler.handle)
|
||||
for (const funcName in apiHandler.version[version]) {
|
||||
const handler = async (c, req, res) => {
|
||||
// parse fields from request
|
||||
const { header, params, query } = c.request;
|
||||
|
||||
let formData = {};
|
||||
if (c.request.method === 'post') {
|
||||
const form = new formidable.IncomingForm();
|
||||
const parseForm = promisify(form.parse).bind(form);
|
||||
formData = await parseForm(req);
|
||||
}
|
||||
|
||||
const fields = Object.assign({}, header, params, query, formData);
|
||||
|
||||
// log request
|
||||
apiLogger.info(`REQUEST, v${version}:${funcName}, ${JSON.stringify(fields)}`);
|
||||
|
||||
// pass to api handler
|
||||
return apiHandler.handle(version, funcName, fields, req, res);
|
||||
};
|
||||
|
||||
// each operation can be called with either GET or POST
|
||||
api.register(`${funcName}UsingGET`, handler);
|
||||
api.register(`${funcName}UsingPOST`, handler);
|
||||
}
|
||||
|
||||
// start and bind to express
|
||||
api.init();
|
||||
app.use(apiRoot, async (req, res) => api.handleRequest(req, req, res));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
@ -1,62 +1,62 @@
|
|||
var express = require('express');
|
||||
var apiHandler = require('../../handler/APIHandler');
|
||||
var apiCaller = require('./apicalls').apiCaller;
|
||||
var settings = require("../../utils/Settings");
|
||||
var settings = require('../../utils/Settings');
|
||||
|
||||
var swaggerModels = {
|
||||
'models': {
|
||||
'SessionInfo' : {
|
||||
"id": 'SessionInfo',
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
models: {
|
||||
SessionInfo: {
|
||||
id: 'SessionInfo',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'string',
|
||||
},
|
||||
"authorID": {
|
||||
"type": "string"
|
||||
authorID: {
|
||||
type: 'string',
|
||||
},
|
||||
"groupID":{
|
||||
"type":"string"
|
||||
groupID: {
|
||||
type: 'string',
|
||||
},
|
||||
"validUntil":{
|
||||
"type":"long"
|
||||
}
|
||||
}
|
||||
validUntil: {
|
||||
type: 'integer',
|
||||
},
|
||||
},
|
||||
},
|
||||
'UserInfo' : {
|
||||
"id": 'UserInfo',
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
UserInfo: {
|
||||
id: 'UserInfo',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'string',
|
||||
},
|
||||
"colorId": {
|
||||
"type": "string"
|
||||
colorId: {
|
||||
type: 'string',
|
||||
},
|
||||
"name":{
|
||||
"type":"string"
|
||||
name: {
|
||||
type: 'string',
|
||||
},
|
||||
"timestamp":{
|
||||
"type":"long"
|
||||
}
|
||||
}
|
||||
timestamp: {
|
||||
type: 'integer',
|
||||
},
|
||||
},
|
||||
},
|
||||
'Message' : {
|
||||
"id": 'Message',
|
||||
"properties": {
|
||||
"text": {
|
||||
"type": "string"
|
||||
Message: {
|
||||
id: 'Message',
|
||||
properties: {
|
||||
text: {
|
||||
type: 'string',
|
||||
},
|
||||
"userId": {
|
||||
"type": "string"
|
||||
userId: {
|
||||
type: 'string',
|
||||
},
|
||||
"userName":{
|
||||
"type":"string"
|
||||
userName: {
|
||||
type: 'string',
|
||||
},
|
||||
"time":{
|
||||
"type":"long"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
time: {
|
||||
type: 'integer',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
function sessionListResponseProcessor(res) {
|
||||
|
|
@ -64,7 +64,7 @@ function sessionListResponseProcessor(res) {
|
|||
var sessions = [];
|
||||
for (var sessionId in res.data) {
|
||||
var sessionInfo = res.data[sessionId];
|
||||
sessionId["id"] = sessionId;
|
||||
sessionId['id'] = sessionId;
|
||||
sessions.push(sessionInfo);
|
||||
}
|
||||
res.data = sessions;
|
||||
|
|
@ -75,284 +75,284 @@ function sessionListResponseProcessor(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"}}
|
||||
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"}}
|
||||
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"
|
||||
delete: {
|
||||
func: 'deleteGroup',
|
||||
description: 'deletes a group',
|
||||
},
|
||||
"listPads" : {
|
||||
"func": "listPads",
|
||||
"description": "returns all pads of this group",
|
||||
"response": {"padIDs":{"type":"List", "items":{"type":"string"}}}
|
||||
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"
|
||||
createPad: {
|
||||
func: 'createGroupPad',
|
||||
description: 'creates a new pad in this group',
|
||||
},
|
||||
"listSessions": {
|
||||
"func": "listSessionsOfGroup",
|
||||
"responseProcessor": sessionListResponseProcessor,
|
||||
"description": "",
|
||||
"response": {"sessions":{"type":"List", "items":{"type":"SessionInfo"}}}
|
||||
listSessions: {
|
||||
func: 'listSessionsOfGroup',
|
||||
responseProcessor: sessionListResponseProcessor,
|
||||
description: '',
|
||||
response: { sessions: { type: 'List', items: { type: 'SessionInfo' } } },
|
||||
},
|
||||
"list": {
|
||||
"func": "listAllGroups",
|
||||
"description": "",
|
||||
"response": {"groupIDs":{"type":"List", "items":{"type":"string"}}}
|
||||
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"}}
|
||||
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"}}
|
||||
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"}}}
|
||||
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"}}}
|
||||
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) {
|
||||
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'] = { 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"}}
|
||||
response: { info: { type: 'UserInfo' } },
|
||||
},
|
||||
"delete" : {
|
||||
"func": "deleteSession",
|
||||
"description": "deletes a 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",
|
||||
"responseProcessor": function(response) {
|
||||
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'] = response.data;
|
||||
delete response['data'];
|
||||
}
|
||||
},
|
||||
"response": {"info":{"type":"SessionInfo"}}
|
||||
}
|
||||
response: { info: { type: 'SessionInfo' } },
|
||||
},
|
||||
},
|
||||
"pad": {
|
||||
"listAll" : {
|
||||
"func": "listAllPads",
|
||||
"description": "list all the pads",
|
||||
"response": {"padIDs":{"type":"List", "items": {"type" : "string"}}}
|
||||
pad: {
|
||||
listAll: {
|
||||
func: 'listAllPads',
|
||||
description: 'list all the pads',
|
||||
response: { padIDs: { type: 'List', items: { type: 'string' } } },
|
||||
},
|
||||
"createDiffHTML" : {
|
||||
"func" : "createDiffHTML",
|
||||
"description": "",
|
||||
"response": {}
|
||||
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"
|
||||
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"}}
|
||||
getText: {
|
||||
func: 'getText',
|
||||
description: 'returns the text of a pad',
|
||||
response: { text: { type: 'string' } },
|
||||
},
|
||||
"setText" : {
|
||||
"func" : "setText",
|
||||
"description": "sets the text of a pad"
|
||||
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"}}
|
||||
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"
|
||||
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":"long"}}
|
||||
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":"long"}}
|
||||
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"
|
||||
delete: {
|
||||
func: 'deletePad',
|
||||
description: 'deletes a pad',
|
||||
},
|
||||
"getReadOnlyID": {
|
||||
"func" : "getReadOnlyID",
|
||||
"description": "returns the read only link of a pad",
|
||||
"response": {"readOnlyID":{"type":"string"}}
|
||||
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"
|
||||
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"}}
|
||||
getPublicStatus: {
|
||||
func: 'getPublicStatus',
|
||||
description: 'return true of false',
|
||||
response: { publicStatus: { type: 'boolean' } },
|
||||
},
|
||||
"setPassword": {
|
||||
"func": "setPassword",
|
||||
"description": "returns ok or a error message"
|
||||
setPassword: {
|
||||
func: 'setPassword',
|
||||
description: 'returns ok or a error message',
|
||||
},
|
||||
"isPasswordProtected": {
|
||||
"func": "isPasswordProtected",
|
||||
"description": "returns true or false",
|
||||
"response": {"passwordProtection":{"type":"boolean"}}
|
||||
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"}}}
|
||||
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": "long"}}
|
||||
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"}}}
|
||||
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"
|
||||
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"
|
||||
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"}}}
|
||||
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) {
|
||||
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'] = { time: response.data['chatHead'] };
|
||||
delete response['data'];
|
||||
}
|
||||
},
|
||||
"response": {"chatHead":{"type":"Message"}}
|
||||
response: { chatHead: { type: 'Message' } },
|
||||
},
|
||||
"appendChatMessage": {
|
||||
"func": "appendChatMessage",
|
||||
"description": "appends a chat message"
|
||||
}
|
||||
}
|
||||
appendChatMessage: {
|
||||
func: 'appendChatMessage',
|
||||
description: 'appends a chat message',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
function capitalise(string){
|
||||
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"
|
||||
properties: {
|
||||
code: {
|
||||
type: 'int',
|
||||
},
|
||||
"message":{
|
||||
"type":"string"
|
||||
}
|
||||
}
|
||||
message: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
var responseModelId = "Response";
|
||||
var responseModelId = 'Response';
|
||||
|
||||
// Add the data properties (if any) to the response
|
||||
if (API[resource][func]["response"]) {
|
||||
if (API[resource][func]['response']) {
|
||||
// This is a specific response so let's set a new id
|
||||
responseModelId = capitalise(resource) + capitalise(func) + "Response";
|
||||
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;
|
||||
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;
|
||||
responseModel['id'] = responseModelId;
|
||||
|
||||
// Add this to the swagger models
|
||||
swaggerModels['models'][responseModelId] = responseModel;
|
||||
|
||||
// Store the response model id
|
||||
API[resource][func]["responseClass"] = responseModelId;
|
||||
|
||||
API[resource][func]['responseClass'] = responseModelId;
|
||||
}
|
||||
}
|
||||
|
||||
function newSwagger() {
|
||||
var swagger_module = require.resolve("swagger-node-express");
|
||||
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];});
|
||||
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");
|
||||
return require('swagger-node-express');
|
||||
}
|
||||
|
||||
exports.expressCreateServer = function (hook_name, args, cb) {
|
||||
|
||||
exports.expressCreateServer = function(hook_name, args, cb) {
|
||||
for (var version in apiHandler.version) {
|
||||
|
||||
var swagger = newSwagger();
|
||||
var basePath = "/rest/" + version;
|
||||
var basePath = '/rest/' + version;
|
||||
|
||||
// Let's put this under /rest for now
|
||||
var subpath = express();
|
||||
|
|
@ -360,52 +360,51 @@ exports.expressCreateServer = function (hook_name, args, cb) {
|
|||
args.app.use(basePath, subpath);
|
||||
|
||||
//hack!
|
||||
var swagger_temp = swagger
|
||||
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.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"]];
|
||||
var apiFunc = apiHandler.version[version][func['func']];
|
||||
|
||||
// Skip this one if it does not exist in the version
|
||||
if(!apiFunc) {
|
||||
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");
|
||||
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"]
|
||||
responseClass: func['responseClass'],
|
||||
},
|
||||
'action': (function(func, responseProcessor) {
|
||||
return function (req,res) {
|
||||
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) {
|
||||
res.send = function(response) {
|
||||
// ugly but we need to get this as json
|
||||
response = JSON.parse(response);
|
||||
// process the response if needed
|
||||
|
|
@ -414,7 +413,7 @@ exports.expressCreateServer = function (hook_name, args, cb) {
|
|||
}
|
||||
// Let's move everything out of "data"
|
||||
if (response.data) {
|
||||
for(var prop in response.data) {
|
||||
for (var prop in response.data) {
|
||||
response[prop] = response.data[prop];
|
||||
delete response.data;
|
||||
}
|
||||
|
|
@ -425,7 +424,7 @@ exports.expressCreateServer = function (hook_name, args, cb) {
|
|||
|
||||
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);
|
||||
|
|
@ -433,11 +432,11 @@ exports.expressCreateServer = function (hook_name, args, cb) {
|
|||
}
|
||||
|
||||
swagger.setHeaders = function setHeaders(res) {
|
||||
res.header('Access-Control-Allow-Origin', "*");
|
||||
res.header('Access-Control-Allow-Origin', '*');
|
||||
};
|
||||
|
||||
swagger.configureSwaggerPaths("", "/api" , "");
|
||||
swagger.configureSwaggerPaths('', '/api', '');
|
||||
|
||||
swagger.configure("http://" + settings.ip + ":" + settings.port + basePath, version);
|
||||
swagger.configure('http://' + settings.ip + ':' + settings.port + basePath, version);
|
||||
}
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue