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

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

Answer 3

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

或者，您可以将所有路由作为数组访问，然后将其映射，如果您使用better-console之类的库在节点中为console.table提供路径，则更好。以下内容在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));
}

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

3 个答案: