forked from bhanuc/koa-joi-router-2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
koa-joi-router-2.js
94 lines (82 loc) · 2.43 KB
/
koa-joi-router-2.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
'use strict';
const documentationRouter = require('koa-router')();
const docspec = require('./lib/base-spec.js');
const generator = require('./lib/generator.js');
const validator = require('./lib/validator.js');
const _ = require('lodash');
const requireAll = require('require-all');
let json_schemas;
/**
* Generate a Swagger 2.0 specification as an object for this API.
*
* @param {object} baseSpec - base document
* @param {object} baseSpec.info
* @param {string} baseSpec.info.title
* @param {string} baseSpec.info.version
* @param {object} baseSpec.tags
* @param {string} baseSpec.tags.name
* @param {string} baseSpec.tags.description
* @param {object} [options]
* @param {object} [options.warnFunc]
* @param {object} [options.defaultResponses]
* @returns {object} swagger 2.0 specification
*/
const generateSpec = (baseSpec, userOptions, controllers, json_schemas) => {
const options = Object.assign({
warnFunc: console.warn,
defaultResponses: {
200: {
description: 'Success'
}
}
}, userOptions);
let apiRoutes = _.map(controllers, controller => controller.stack);
apiRoutes = _.flatten(apiRoutes).filter(route => route.name).map(route => {
return {
method: route.methods,
paramNames: route.paramNames,
path: route.path,
name: route.name,
prefix: route.opts.prefix
};
});
const doc = _.cloneDeep(baseSpec);
doc.swagger = '2.0';
doc.paths = doc.paths || {};
doc.tags = doc.tags || [];
apiRoutes.forEach(function (apiRoute) {
const routeOptions = Object.assign({}, options, {
prefix: apiRoute.prefix
});
const routePaths = generator.routeToSwaggerPaths(apiRoute, routeOptions, json_schemas);
generator.mergeSwaggerPaths(doc.paths, routePaths, options);
});
return doc;
};
module.exports = {
generator: (controllers, specPath, baseSpec) => {
const specInput = Object.assign({}, docspec.base, baseSpec)
const json_schemas = requireAll(specPath);
const spec = generateSpec(specInput, docspec.baseOptions, controllers, json_schemas);
/**
* Swagger JSON API
*/
documentationRouter.get('/_api.json', async ctx => {
ctx.body = JSON.stringify(spec, null, ' ');
});
/**
* API documentation in redoc
*/
documentationRouter.get('/redoc', async ctx => {
ctx.body = docspec.redoc;
});
/**
* API documentation in swagger
*/
documentationRouter.get('/swagger', async ctx => {
ctx.body = docspec.swagger;
});
return documentationRouter;
},
validator
};