Expressに登録されているすべてのルートを取得するにはどうすればよいですか?


181

Node.jsとExpressを使用して構築されたWebアプリケーションがあります。ここで、登録されたすべてのルートを適切な方法でリストしたいと思います。

たとえば、私が実行した場合

app.get('/', function (...) { ... });
app.get('/foo/:id', function (...) { ... });
app.post('/foo/:id', function (...) { ... });

次のようなオブジェクト(またはそれに相当するもの)を取得したいと思います。

{
  get: [ '/', '/foo/:id' ],
  post: [ '/foo/:id' ]
}

これは可能ですか?可能な場合、どのように?


更新:その間、私はこの問題を解決する、与えられたアプリケーションからルートを抽出するget-routesと呼ばれるnpmパッケージを作成しました。現在、サポートされているのはExpress 4.xだけですが、今のところこれで問題ありません。参考までに。


私が試したすべてのソリューションは、ルーターが定義されている場合は機能しません。それはルートごとにのみ機能します-これは私のアプリでそのルートの完全なURLを与えません...
guy mograbi

回答:


230

Express 3.x

わかった、自分で見つけた...それはただapp.routes:-)

Express 4.x

アプリケーション -で構築express()

app._router.stack

ルーター -で構築express.Router()

router.stack

:スタックにはミドルウェア機能も含まれています。「ルート」のみを取得するようにフィルタリングする必要があります


私はノード0.10を使用していますが、これはapp.routes.routesJSON.stringify(app.routes.routes)を実行できることを意味します
ガイモグラビ14

7
Express 3.xでのみ機能し、4.xでは機能しません。4.xでは、次を確認する必要がありますapp._router.stack
avetisk 2014

14
これは期待通りに機能しませんでした。app._routerにはapp.use( '/ path'、otherRouter);からのルートが含まれていないようです。
Michael Cole

これをコマンドラインスクリプトと統合して、実際にウェブアプリを起動せずに、ライブアプリとまったく同じルートファイルを取得する方法はありますか?
Lawrence I.

5
少なくともExpress 4.13.1 app._router.stackでは未定義です。
levigroker

54
app._router.stack.forEach(function(r){
  if (r.route && r.route.path){
    console.log(r.route.path)
  }
})

1
Express Router(または他のミドルウェア)のようなものを使用している場合は、このアプローチを拡張した少し長い@Calebの回答が表示されるはずです。
Iain Collins

31

これは、(app.VERBを介して)アプリに直接登録されたルートと(app.useを介して)ルーターミドルウェアとして登録されたルートを取得します。Express 4.11.0

//////////////
app.get("/foo", function(req,res){
    res.send('foo');
});

//////////////
var router = express.Router();

router.get("/bar", function(req,res,next){
    res.send('bar');
});

app.use("/",router);


//////////////
var route, routes = [];

app._router.stack.forEach(function(middleware){
    if(middleware.route){ // routes registered directly on the app
        routes.push(middleware.route);
    } else if(middleware.name === 'router'){ // router middleware 
        middleware.handle.stack.forEach(function(handler){
            route = handler.route;
            route && routes.push(route);
        });
    }
});

// routes:
// {path: "/foo", methods: {get: true}}
// {path: "/bar", methods: {get: true}}

1
Expressルーターなどのミドルウェアを介して表示ルートを設定する方法を示す例に感謝します。
Iain Collins

31

オンラインではなくなった古い投稿を自分のニーズに適合させました。私はexpress.Router()を使用して、次のようにルートを登録しました:

var questionsRoute = require('./BE/routes/questions');
app.use('/api/questions', questionsRoute);

apiTable.jsのdocument.jsファイルの名前を変更し、次のように適合させました。

module.exports =  function (baseUrl, routes) {
    var Table = require('cli-table');
    var table = new Table({ head: ["", "Path"] });
    console.log('\nAPI for ' + baseUrl);
    console.log('\n********************************************');

    for (var key in routes) {
        if (routes.hasOwnProperty(key)) {
            var val = routes[key];
            if(val.route) {
                val = val.route;
                var _o = {};
                _o[val.stack[0].method]  = [baseUrl + val.path];    
                table.push(_o);
            }       
        }
    }

    console.log(table.toString());
    return table;
};

次に、これを私のserver.jsで次のように呼び出します。

var server = app.listen(process.env.PORT || 5000, function () {
    require('./BE/utils/apiTable')('/api/questions', questionsRoute.stack);
});

結果は次のようになります。

結果の例

これは単なる例ですが、役に立つかもしれません。


2
ここで特定され、これは、ネストされたルートのために動作しません:stackoverflow.com/questions/25260818/...

2
この回答のリンクに注意してください!ランダムなWebサイトにリダイレクトされ、コンピューターにダウンロードされました。
タイラーベル

29

これは、Express 4.xで登録済みパスを取得するために使用する小さなものです

app._router.stack          // registered routes
  .filter(r => r.route)    // take out all the middleware
  .map(r => r.route.path)  // get all the paths

console.log(server._router.stack.map(r => r.route).filter(r => r).map(r => ${Object.keys(r.methods).join(', ')} ${r.path}))
standup75 '11

これをapp.jsのどこに配置しますか?
フアン

21

DEBUG=express:* node index.js

上記のコマンドを使用してアプリを実行すると、DEBUGモジュールを使用してアプリが起動し、ルートと、使用中のすべてのミドルウェア機能が提供されます。

あなたは参照することができます:ExpressJS-デバッグデバッグ


3
断然最良の答え... 1つの環境変数!
Jeef

確かに、最も役立つ答え。@nbsamar DEBUG=express:paths他のすべてのデバッグメッセージではなく、パス出力のみを表示するために使用するように拡張することもできます。ありがとう!
マークエディントン

19

ハックコピー/の回答礼儀貼りダグ・ウィルソン急行githubの問題。汚れていますが、魅力のように機能します。

function print (path, layer) {
  if (layer.route) {
    layer.route.stack.forEach(print.bind(null, path.concat(split(layer.route.path))))
  } else if (layer.name === 'router' && layer.handle.stack) {
    layer.handle.stack.forEach(print.bind(null, path.concat(split(layer.regexp))))
  } else if (layer.method) {
    console.log('%s /%s',
      layer.method.toUpperCase(),
      path.concat(split(layer.regexp)).filter(Boolean).join('/'))
  }
}

function split (thing) {
  if (typeof thing === 'string') {
    return thing.split('/')
  } else if (thing.fast_slash) {
    return ''
  } else {
    var match = thing.toString()
      .replace('\\/?', '')
      .replace('(?=\\/|$)', '$')
      .match(/^\/\^((?:\\[.*+?^${}()|[\]\\\/]|[^.*+?^${}()|[\]\\\/])*)\$\//)
    return match
      ? match[1].replace(/\\(.)/g, '$1').split('/')
      : '<complex:' + thing.toString() + '>'
  }
}

app._router.stack.forEach(print.bind(null, []))

生産する

スクリーングラブ


ルートが区別されないのはなぜですか?
Vladimir Vukanac

1
これはExpress 4.15で私のために働いた唯一のものです。他の誰もフルパスを与えませんでした。唯一の注意点は、デフォルトのルートパス/を返さないことです。
シェーン

なぜあなたは引数をバインドするのか分かりませんprintか?
ZzZombo 2018年

@ZzZomboはDoug Wilsonに尋ね、彼はそれを書いた。必要に応じて、おそらくこれらすべてをクリーンアップできます。
AlienWebguy

11

https://www.npmjs.com/package/express-list-endpointsはかなりうまく機能します。

使用法:

const all_routes = require('express-list-endpoints');
console.log(all_routes(app));

出力:

[ { path: '*', methods: [ 'OPTIONS' ] },
  { path: '/', methods: [ 'GET' ] },
  { path: '/sessions', methods: [ 'POST' ] },
  { path: '/sessions', methods: [ 'DELETE' ] },
  { path: '/users', methods: [ 'GET' ] },
  { path: '/users', methods: [ 'POST' ] } ]

2
これは動作しません: server = express(); app1 = express(); server.use('/app1', app1); ...
Danosaure

8

すべてのルートをExpress 4でログに記録する機能(v3〜用に簡単に調整できます)

function space(x) {
    var res = '';
    while(x--) res += ' ';
    return res;
}

function listRoutes(){
    for (var i = 0; i < arguments.length;  i++) {
        if(arguments[i].stack instanceof Array){
            console.log('');
            arguments[i].stack.forEach(function(a){
                var route = a.route;
                if(route){
                    route.stack.forEach(function(r){
                        var method = r.method.toUpperCase();
                        console.log(method,space(8 - method.length),route.path);
                    })
                }
            });
        }
    }
}

listRoutes(router, routerAuth, routerHTML);

ログ出力:

GET       /isAlive
POST      /test/email
POST      /user/verify

PUT       /login
POST      /login
GET       /player
PUT       /player
GET       /player/:id
GET       /players
GET       /system
POST      /user
GET       /user
PUT       /user
DELETE    /user

GET       /
GET       /login

これをNPMにしたhttps://www.npmjs.com/package/express-list-routes


1
これは期待通りに機能しませんでした。app._routerにはapp.use( '/ path'、otherRouter);からのルートが含まれていないようです。
Michael Cole

@MichaelColeゴロローデンからの以下の答えを見ましたか?
Labithiotis 2014

@ Dazzler13私はこれを1時間試してみましたが、機能させることができませんでした。Express 4.0。作成されたアプリ、作成されたルーター、app.use(path、router)、ルーターのルートがapp._routerに表示されませんでした。例?
マイケルコール

以下の@Calebの例は、express.Routerなどで処理されたルートで問題なく機能します。ミドルウェア(express.Routerを含む)で設定されたルートはすぐに表示されない場合があり、(@ Calebからのアプローチを使用しても)app._routerでチェックする前に少し遅延を追加する必要がある場合があります。
Iain Collins

8

JSON出力

function availableRoutes() {
  return app._router.stack
    .filter(r => r.route)
    .map(r => {
      return {
        method: Object.keys(r.route.methods)[0].toUpperCase(),
        path: r.route.path
      };
    });
}

console.log(JSON.stringify(availableRoutes(), null, 2));

このようになります:

[
  {
    "method": "GET",
    "path": "/api/todos"
  },
  {
    "method": "POST",
    "path": "/api/todos"
  },
  {
    "method": "PUT",
    "path": "/api/todos/:id"
  },
  {
    "method": "DELETE",
    "path": "/api/todos/:id"
  }
]

文字列出力

function availableRoutesString() {
  return app._router.stack
    .filter(r => r.route)
    .map(r => Object.keys(r.route.methods)[0].toUpperCase().padEnd(7) + r.route.path)
    .join("\n  ")
}

console.log(availableRoutesString());

このようになります:

GET    /api/todos  
POST   /api/todos  
PUT    /api/todos/:id  
DELETE /api/todos/:id

これらは@corvidの回答に基づいています

お役に立てれば


5

私はLabithiotisのexpress-list-routesに触発されましたが、すべてのルートとブルートURLの概要を一度に確認し、ルーターを指定せず、毎回プレフィックスを把握しました。私が思いついたのは、app.use関数を、baseUrlおよび指定されたルーターを格納する独自の関数に単純に置き換えることでした。そこから、すべてのルートのテーブルを印刷できます。

次のように、アプリオブジェクトで渡される特定のルートファイル(関数)でルートを宣言するため、これは私にとっては機能します。

// index.js
[...]
var app = Express();
require(./config/routes)(app);

// ./config/routes.js
module.exports = function(app) {
    // Some static routes
    app.use('/users', [middleware], UsersRouter);
    app.use('/users/:user_id/items', [middleware], ItemsRouter);
    app.use('/otherResource', [middleware], OtherResourceRouter);
}

これにより、偽の関数を使用して別の「アプリ」オブジェクトを渡すことができ、すべてのルートを取得できます。これは私にとってはうまくいきます(明確にするためにいくつかのエラーチェックを削除しましたが、例ではまだうまくいきます):

// In printRoutes.js (or a gulp task, or whatever)
var Express = require('express')
  , app     = Express()
  , _       = require('lodash')

// Global array to store all relevant args of calls to app.use
var APP_USED = []

// Replace the `use` function to store the routers and the urls they operate on
app.use = function() {
  var urlBase = arguments[0];

  // Find the router in the args list
  _.forEach(arguments, function(arg) {
    if (arg.name == 'router') {
      APP_USED.push({
        urlBase: urlBase,
        router: arg
      });
    }
  });
};

// Let the routes function run with the stubbed app object.
require('./config/routes')(app);

// GRAB all the routes from our saved routers:
_.each(APP_USED, function(used) {
  // On each route of the router
  _.each(used.router.stack, function(stackElement) {
    if (stackElement.route) {
      var path = stackElement.route.path;
      var method = stackElement.route.stack[0].method.toUpperCase();

      // Do whatever you want with the data. I like to make a nice table :)
      console.log(method + " -> " + used.urlBase + path);
    }
  });
});

この完全な例(いくつかの基本的なCRUDルーターを含む)はテストされ、印刷されたばかりです。

GET -> /users/users
GET -> /users/users/:user_id
POST -> /users/users
DELETE -> /users/users/:user_id
GET -> /users/:user_id/items/
GET -> /users/:user_id/items/:item_id
PUT -> /users/:user_id/items/:item_id
POST -> /users/:user_id/items/
DELETE -> /users/:user_id/items/:item_id
GET -> /otherResource/
GET -> /otherResource/:other_resource_id
POST -> /otherResource/
DELETE -> /otherResource/:other_resource_id

cli-tableを使用すると、次のような結果が得られます。

┌────────┬───────────────────────┐
         => Users              
├────────┼───────────────────────┤
 GET     /users/users          
├────────┼───────────────────────┤
 GET     /users/users/:user_id 
├────────┼───────────────────────┤
 POST    /users/users          
├────────┼───────────────────────┤
 DELETE  /users/users/:user_id 
└────────┴───────────────────────┘
┌────────┬────────────────────────────────┐
         => Items                       
├────────┼────────────────────────────────┤
 GET     /users/:user_id/items/         
├────────┼────────────────────────────────┤
 GET     /users/:user_id/items/:item_id 
├────────┼────────────────────────────────┤
 PUT     /users/:user_id/items/:item_id 
├────────┼────────────────────────────────┤
 POST    /users/:user_id/items/         
├────────┼────────────────────────────────┤
 DELETE  /users/:user_id/items/:item_id 
└────────┴────────────────────────────────┘
┌────────┬───────────────────────────────────┐
         => OtherResources                 
├────────┼───────────────────────────────────┤
 GET     /otherResource/                   
├────────┼───────────────────────────────────┤
 GET     /otherResource/:other_resource_id 
├────────┼───────────────────────────────────┤
 POST    /otherResource/                   
├────────┼───────────────────────────────────┤
 DELETE  /otherResource/:other_resource_id 
└────────┴───────────────────────────────────┘

お尻を蹴る。


4

エクスプレス4

エンドポイントとネストされたルーターを備えたExpress 4の構成を想定

const express = require('express')
const app = express()
const router = express.Router()

app.get(...)
app.post(...)

router.use(...)
router.get(...)
router.post(...)

app.use(router)

@calebの回答を拡張すると、すべてのルートを再帰的に取得してソートできます。

getRoutes(app._router && app._router.stack)
// =>
// [
//     [ 'GET', '/'], 
//     [ 'POST', '/auth'],
//     ...
// ]

/**
* Converts Express 4 app routes to an array representation suitable for easy parsing.
* @arg {Array} stack An Express 4 application middleware list.
* @returns {Array} An array representation of the routes in the form [ [ 'GET', '/path' ], ... ].
*/
function getRoutes(stack) {
        const routes = (stack || [])
                // We are interested only in endpoints and router middleware.
                .filter(it => it.route || it.name === 'router')
                // The magic recursive conversion.
                .reduce((result, it) => {
                        if (! it.route) {
                                // We are handling a router middleware.
                                const stack = it.handle.stack
                                const routes = getRoutes(stack)

                                return result.concat(routes)
                        }

                        // We are handling an endpoint.
                        const methods = it.route.methods
                        const path = it.route.path

                        const routes = Object
                                .keys(methods)
                                .map(m => [ m.toUpperCase(), path ])

                        return result.concat(routes)
                }, [])
                // We sort the data structure by route path.
                .sort((prev, next) => {
                        const [ prevMethod, prevPath ] = prev
                        const [ nextMethod, nextPath ] = next

                        if (prevPath < nextPath) {
                                return -1
                        }

                        if (prevPath > nextPath) {
                                return 1
                        }

                        return 0
                })

        return routes
}

基本的な文字列出力用。

infoAboutRoutes(app)

コンソール出力

/**
* Converts Express 4 app routes to a string representation suitable for console output.
* @arg {Object} app An Express 4 application
* @returns {string} A string representation of the routes.
*/
function infoAboutRoutes(app) {
        const entryPoint = app._router && app._router.stack
        const routes = getRoutes(entryPoint)

        const info = routes
                .reduce((result, it) => {
                        const [ method, path ] = it

                        return result + `${method.padEnd(6)} ${path}\n`
                }, '')

        return info
}

更新1:

Express 4の内部制限により、マウントされたアプリとマウントされたルーターを取得することはできません。たとえば、この構成からルートを取得することはできません。

const subApp = express()
app.use('/sub/app', subApp)

const subRouter = express.Router()
app.use('/sub/route', subRouter)

マウントされたルートのリストはこのパッケージで動作します:github.com/AlbertoFdzM/express-list-endpoints
jsaddwater

4

いくつかの調整が必要ですが、Express v4で動作するはずです。で追加されたルートを含み.use()ます。

function listRoutes(routes, stack, parent){

  parent = parent || '';
  if(stack){
    stack.forEach(function(r){
      if (r.route && r.route.path){
        var method = '';

        for(method in r.route.methods){
          if(r.route.methods[method]){
            routes.push({method: method.toUpperCase(), path: parent + r.route.path});
          }
        }       

      } else if (r.handle && r.handle.name == 'router') {
        const routerName = r.regexp.source.replace("^\\","").replace("\\/?(?=\\/|$)","");
        return listRoutes(routes, r.handle.stack, parent + routerName);
      }
    });
    return routes;
  } else {
    return listRoutes([], app._router.stack);
  }
}

//Usage on app.js
const routes = listRoutes(); //array: ["method: path", "..."]

編集:コードの改善


3

@prranayの答えに対する少し更新されたより機能的なアプローチ:

const routes = app._router.stack
    .filter((middleware) => middleware.route)
    .map((middleware) => `${Object.keys(middleware.route.methods).join(', ')} -> ${middleware.route.path}`)

console.log(JSON.stringify(routes, null, 4));

2

これは私のために働いた

let routes = []
app._router.stack.forEach(function (middleware) {
    if(middleware.route) {
        routes.push(Object.keys(middleware.route.methods) + " -> " + middleware.route.path);
    }
});

console.log(JSON.stringify(routes, null, 4));

O / P:

[
    "get -> /posts/:id",
    "post -> /posts",
    "patch -> /posts"
]

2

エクスプレスルーターの初期化

let router = require('express').Router();
router.get('/', function (req, res) {
    res.json({
        status: `API Its Working`,
        route: router.stack.filter(r => r.route)
           .map(r=> { return {"path":r.route.path, 
 "methods":r.route.methods}}),
        message: 'Welcome to my crafted with love!',
      });
   });   

ユーザーコントローラーのインポート

var userController = require('./controller/userController');

ユーザールート

router.route('/users')
   .get(userController.index)
   .post(userController.new);
router.route('/users/:user_id')
   .get(userController.view)
   .patch(userController.update)
   .put(userController.update)
   .delete(userController.delete);

APIルートのエクスポート

module.exports = router;

出力

{"status":"API Its Working, APP Route","route": 
[{"path":"/","methods":{"get":true}}, 
{"path":"/users","methods":{"get":true,"post":true}}, 
{"path":"/users/:user_id","methods": ....}

1

Express 3.5.xでは、アプリを起動する前にこれを追加して、ルートを端末に印刷します。

var routes = app.routes;
for (var verb in routes){
    if (routes.hasOwnProperty(verb)) {
      routes[verb].forEach(function(route){
        console.log(verb + " : "+route['path']);
      });
    }
}

多分それは助けることができます...


1

/get-all-routesAPI を実装できます。

const express = require("express");
const app = express();

app.get("/get-all-routes", (req, res) => {  
  let get = app._router.stack.filter(r => r.route && r.route.methods.get).map(r => r.route.path);
  let post = app._router.stack.filter(r => r.route && r.route.methods.post).map(r => r.route.path);
  res.send({ get: get, post: post });
});

const listener = app.listen(process.env.PORT, () => {
  console.log("Your app is listening on port " + listener.address().port);
});

ここにデモがあります:https : //glitch.com/edit/#! / get-all-routes-in-nodejs


0

だから私はすべての答えを見ていました..ほとんどが好きではなかった..いくつかからいくつかを取りました..これを作りました:

const resolveRoutes = (stack) => {
  return stack.map(function (layer) {
    if (layer.route && layer.route.path.isString()) {
      let methods = Object.keys(layer.route.methods);
      if (methods.length > 20)
        methods = ["ALL"];

      return {methods: methods, path: layer.route.path};
    }

    if (layer.name === 'router')  // router middleware
      return resolveRoutes(layer.handle.stack);

  }).filter(route => route);
};

const routes = resolveRoutes(express._router.stack);
const printRoute = (route) => {
  if (Array.isArray(route))
    return route.forEach(route => printRoute(route));

  console.log(JSON.stringify(route.methods) + " " + route.path);
};

printRoute(routes);

かわいくない..入れ子にして、トリックを行う

また、20に注意してください... 20のメソッドでは通常のルートがないと思います。


0

ルートの詳細には、「express」のルートがリストされています:「4.xx」、

import {
  Router
} from 'express';
var router = Router();

router.get("/routes", (req, res, next) => {
  var routes = [];
  var i = 0;
  router.stack.forEach(function (r) {
    if (r.route && r.route.path) {
      r.route.stack.forEach(function (type) {
        var method = type.method.toUpperCase();
        routes[i++] = {
          no:i,
          method: method.toUpperCase(),
          path: r.route.path
        };
      })
    }
  })

  res.send('<h1>List of routes.</h1>' + JSON.stringify(routes));
});

コードの簡単な出力

List of routes.

[
{"no":1,"method":"POST","path":"/admin"},
{"no":2,"method":"GET","path":"/"},
{"no":3,"method":"GET","path":"/routes"},
{"no":4,"method":"POST","path":"/student/:studentId/course/:courseId/topic/:topicId/task/:taskId/item"},
{"no":5,"method":"GET","path":"/student/:studentId/course/:courseId/topic/:topicId/task/:taskId/item"},
{"no":6,"method":"PUT","path":"/student/:studentId/course/:courseId/topic/:topicId/task/:taskId/item/:itemId"},
{"no":7,"method":"DELETE","path":"/student/:studentId/course/:courseId/topic/:topicId/task/:taskId/item/:itemId"}
]

0

このnpmパッケージを使用するだけで、Web出力とターミナル出力が適切な形式のテーブルビューで表示されます。

ここに画像の説明を入力してください

https://www.npmjs.com/package/express-routes-catalogue


2
この他のパッケージはより多くの受け入れがあります。npmjs.com/package/express-list-endpoints。週に34回のダウンロードに対して21.111です。ただし、express-routes-catalogueルートもHTMLとして表示されますが、他のルートは表示されません。
Mayid

1
パッケージのドキュメントは必要なときに実際のパッケージ名とは異なり、このパッケージは他のすべてのパッケージと同様に、含まれている単一レイヤーのルートのみを示しています
hamza khan

@hamzakhan ps更新ありがとうございます。私は作者です。まもなくドキュメントで更新されます。
Vijay

-1

Expressのルートをきれいに出力するための1行の関数を次に示しますapp

const getAppRoutes = (app) => app._router.stack.reduce(
  (acc, val) => acc.concat(
    val.route ? [val.route.path] :
      val.name === "router" ? val.handle.stack.filter(
        x => x.route).map(
          x => val.regexp.toString().match(/\/[a-z]+/)[0] + (
            x.route.path === '/' ? '' : x.route.path)) : []) , []).sort();

-2

すべてのミドルウェアとルートを印刷するパッケージを公開しました。これは、Expressアプリケーションを監査するときに非常に役立ちます。パッケージをミドルウェアとしてマウントすると、それ自体が出力されます。

https://github.com/ErisDS/middleware-stack-printer

次のようなツリーを出力します。

- middleware 1
- middleware 2
- Route /thing/
- - middleware 3
- - controller (HTTP VERB)  
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.