Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-10-26 16:46:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: allow plugins to define api routes

Browse Source 
via new plugin hook static:api.routes
This commit is contained in:
Julian Lam
2020-10-14 17:44:27 -04:00
parent a4ba23899e
commit 9dd3cc0483
2 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/routes/index.js
View File

@@ -112,7 +112,7 @@ module.exports = async function (app, middleware) {
await plugins.reloadRoutes({ router: router });
await authRoutes.reloadRoutes({ router: router });
writeRoutes.reload({ router: router });
await writeRoutes.reload({ router: router });
addCoreRoutes(app, router, middleware);
winston.info('Routes added');

32
src/routes/write/index.js
View File

@@ -1,12 +1,14 @@
'use strict';
const nconf = require('nconf');
const winston = require('winston');
const plugins = require('../../plugins');
const middleware = require('../../middleware');
const helpers = require('../../controllers/helpers');
const Write = module.exports;
Write.reload = (params) => {
Write.reload = async (params) => {
const router = params.router;
router.use('/api/v3', function (req, res, next) {
@@ -40,19 +42,17 @@ Write.reload = (params) => {
});
});
// This router is reserved exclusively for plugins to add their own routes into the write api plugin. Confused yet? :trollface:
// var customRouter = require('express').Router();
// plugins.fireHook('filter:plugin.write-api.routes', {
// router: customRouter,
// apiMiddleware: apiMiddleware,
// middleware: coreMiddleware,
// errorHandler: errorHandler
// }, function (err, payload) {
// router.use('/', payload.router);
// router.use(function(req, res) {
// // Catch-all
// errorHandler.respond(404, res);
// });
// });
/**
* Plugins can add routes to the Write API by attaching a listener to the
* below hook. The hooks added to the passed-in router will be mounted to
* `/api/v3/plugins`.
*/
const pluginRouter = require('express').Router();
await plugins.fireHook('static:api.routes', {
router: pluginRouter,
middleware,
helpers,
});
winston.info(`[api] Adding ${pluginRouter.stack.length} route(s) to \`api/v3/plugins\``);
router.use('/api/v3/plugins', pluginRouter);
};