如何获取我在Restify服务器中使用的所有路由的列表

Question

我有一个设计如下的应用程序；

//server.js =====================================================
var restify = require('restify'),
    route1 = require('./routes/route1),
    route2 = require('./routes/route2),
    ....
    ....
    ....

var server = restify.createServer({
    name: 'xyz_server'
  });

route1(server);
route2(server);

现在每个路由文件看起来像belwo

   //route1.js =====================================================

   module.exports = function(server) {
      server.get('/someRoute',function(req,res,next){
                //.. do something
        });
      server.get('/anotherRoute',function(req,res,next){
                 //..something else
       });

   }; 

现在的问题是，我们总共有十几个路由文件和数百个路由。 这个项目有多个开发人员，每天都会增加一些路线。

Restify中是否有功能为我提供系统中所有路由的列表？

我正在寻找的是这样的：

server.listAllRoutes();

有人知道吗？

Answer 1

试试这个

function listAllRoutes(server){
  console.log('GET paths:');
  server.router.routes.GET.forEach(
    function(value){console.log(value.spec.path);}
    );
  console.log('PUT paths:');
  server.router.routes.PUT.forEach(
    function(value){console.log(value.spec.path);}
    );
}

listAllRoutes(server);

这应该列出所有GET和PUT路径，添加POST和DELETE应该很容易:)

Answer 2

有一个router.getRoutes()方法，但是它返回的对象不是最好用于列出事物的对象。 您可以摆弄它，将其变成具有所需形状的数组。

另外，您可以将所有路由作为数组访问，然后将它们映射，如果您使用诸如better-console类的lib在node中提供console.table ，则better-console 。 以下代码在restify@8.3.0对我来说很restify@8.3.0 ：

import console from 'better-console';

function listRoutes(server) {
  const { routes } = server.router._registry._findMyWay; // beware these are probably meant to be private APIs, they could be subject to change
  const mapped = routes.map(({ method, path }) => ({ method, path }));

  console.table(mapped.sort((a, b) => a.method > b.method));
}

Answer 3

2019更新： server.router.routes不再可用，而是我们有server.router.getRoutes()返回地图。 因此，我们可以使用以下命令记录所有路线：

function listAllRoutes(server) {
  Object.values(server.router.getRoutes()).forEach(value =>
    console.log(
      `ENDPOINT REGISTERED :: ${value.method} :: ${server.url}${value.path}`
    )
  );
}

http://restify.com/docs/server-api/#server