2020-07-28 10:30:10 +02:00
|
|
|
import express from 'express';
|
|
|
|
|
import swaggerUi from 'swagger-ui-dist';
|
2020-05-12 14:05:47 +02:00
|
|
|
import jsonRefParser, {JSONSchema} from '@apidevtools/json-schema-ref-parser';
|
2020-05-13 17:28:18 +02:00
|
|
|
import oasParser from '@apidevtools/swagger-parser';
|
2020-05-12 14:05:47 +02:00
|
|
|
|
|
|
|
|
|
2020-07-28 10:30:10 +02:00
|
|
|
// modified from https://github.com/scottie1984/swagger-ui-express
|
2020-05-26 09:07:01 +02:00
|
|
|
// usage: app.use('/api-doc', api.serve(), api.setup());
|
2020-05-12 14:05:47 +02:00
|
|
|
// the paths property can be split using allOf
|
|
|
|
|
// further route documentation can be included in the x-doc property
|
|
|
|
|
|
|
|
|
|
|
2020-07-28 10:30:10 +02:00
|
|
|
export default function api () {
|
|
|
|
|
// generate apiDoc
|
|
|
|
|
let apiDoc: JSONSchema = {};
|
|
|
|
|
jsonRefParser.bundle('api/api.yaml', (err, doc) => { // parse yaml
|
|
|
|
|
if (err) throw err;
|
|
|
|
|
apiDoc = doc;
|
|
|
|
|
apiDoc.servers.splice(process.env.NODE_ENV === 'production', 1);
|
|
|
|
|
apiDoc.paths = apiDoc.paths.allOf.reduce((s, e) => Object.assign(s, e)); // bundle routes
|
|
|
|
|
apiDoc = resolveXDoc(apiDoc);
|
|
|
|
|
oasParser.validate(apiDoc, (err, api) => { // validate oas schema
|
|
|
|
|
if (err) {
|
|
|
|
|
console.error(err);
|
2020-05-12 14:05:47 +02:00
|
|
|
}
|
2020-07-28 10:30:10 +02:00
|
|
|
else {
|
|
|
|
|
console.info(process.env.NODE_ENV === 'test' ? '' : 'API ok, version ' + api.info.version);
|
2020-05-12 14:05:47 +02:00
|
|
|
}
|
|
|
|
|
});
|
2020-07-28 10:30:10 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return [
|
|
|
|
|
(req, res, next) => { // serve init js and apiDoc file
|
|
|
|
|
switch (req.url) {
|
|
|
|
|
case '/swagger-ui-init.js':
|
|
|
|
|
res.set('Content-Type', 'application/javascript');
|
|
|
|
|
res.send(jsTplString);
|
|
|
|
|
break;
|
|
|
|
|
case '/apidoc.json':
|
|
|
|
|
res.set('Content-Type', 'application/json');
|
|
|
|
|
res.send(apiDoc);
|
|
|
|
|
break;
|
|
|
|
|
default:
|
|
|
|
|
next();
|
|
|
|
|
}
|
|
|
|
|
}, // serve swagger files
|
|
|
|
|
express.static(swaggerUi.getAbsoluteFSPath(), {index: false}),
|
|
|
|
|
(req, res) => { // serve html file as default
|
|
|
|
|
res.send(htmlTplString);
|
|
|
|
|
}
|
|
|
|
|
];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
function resolveXDoc (doc) { // resolve x-doc properties recursively
|
|
|
|
|
Object.keys(doc).forEach(key => {
|
|
|
|
|
if (doc[key] !== null && doc[key].hasOwnProperty('x-doc')) { // add x-doc to description, is styled via css
|
|
|
|
|
doc[key].description += '<details class="docs"><summary>docs</summary>' + doc[key]['x-doc'] + '</details>';
|
|
|
|
|
}
|
|
|
|
|
else if (typeof doc[key] === 'object' && doc[key] !== null) { // go deeper into recursion
|
|
|
|
|
doc[key] = resolveXDoc(doc[key]);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
return doc;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// templates
|
|
|
|
|
|
|
|
|
|
const htmlTplString = `
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<title>API documentation</title>
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="/static/styles/swagger-ui.css" >
|
|
|
|
|
<link rel="icon" type="image/png" href="/static/img/favicon.ico">
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
|
|
|
|
|
<defs>
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="unlocked">
|
|
|
|
|
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="locked">
|
|
|
|
|
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="close">
|
|
|
|
|
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="large-arrow">
|
|
|
|
|
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="large-arrow-down">
|
|
|
|
|
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol viewBox="0 0 24 24" id="jump-to">
|
|
|
|
|
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
<symbol viewBox="0 0 24 24" id="expand">
|
|
|
|
|
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
</defs>
|
|
|
|
|
</svg>
|
|
|
|
|
<div id="swagger-ui"></div>
|
|
|
|
|
<script src="./swagger-ui-bundle.js"> </script>
|
|
|
|
|
<script src="./swagger-ui-standalone-preset.js"> </script>
|
|
|
|
|
<script src="./swagger-ui-init.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const jsTplString = `
|
|
|
|
|
window.onload = function() {
|
|
|
|
|
// Build a system
|
|
|
|
|
window.ui = SwaggerUIBundle({
|
|
|
|
|
url: '/api-doc/apidoc.json',
|
|
|
|
|
dom_id: '#swagger-ui',
|
|
|
|
|
deepLinking: true,
|
|
|
|
|
presets: [
|
|
|
|
|
SwaggerUIBundle.presets.apis,
|
|
|
|
|
SwaggerUIStandalonePreset
|
|
|
|
|
],
|
|
|
|
|
plugins: [
|
|
|
|
|
SwaggerUIBundle.plugins.DownloadUrl
|
|
|
|
|
],
|
|
|
|
|
layout: 'StandaloneLayout'
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
`;
|
