什么是 express-list-endpoints？
express-list-endpoints 是一个 npm 包，它可以帮助我们生成一个包含了 express 应用中所有路由的列表。这个列表可以用于调试和文档生成等目的。
安装
要安装 express-list-endpoints，我们可以在项目目录下运行以下命令：
npm install express-list-endpoints --save-dev
示例
在使用 express-list-endpoints 之前，需要先创建一个基本的 express 应用，例如：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- --------- --- ---------------- -- -- - -------------------- --- --------- -- ---- -------- ---展开代码
接着，我们需要在应用中引入 express-list-endpoints，并使用它生成路由列表，例如：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------------- - ---------------------------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- --------- --- -- ------ ----- --------- - ------------------- ----------------------- ---------------- -- -- - -------------------- --- --------- -- ---- -------- ---展开代码
运行以上代码，将会在控制台中输出以下信息：
[ { methods: [ 'GET' ], path: '/' } ]
这个信息告诉我们，应用中只有一个路由，它是一个 GET 方法，并且对应的路径是 /。
更多用法
除了上面的例子，express-list-endpoints 还提供了一些其它的用法：
打印路由列表到文件
可以使用 Node.js 的 fs 模块将路由列表输出到一个文件中，例如：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------------- - ---------------------------------- ----- -- - -------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- --------- --- -- ------ ----- --------- - ------------------- -- ---------- ---------------------------------- ------------------------- ----- ---- ---------------- -- -- - -------------------- --- --------- -- ---- -------- ---展开代码
结合 Swagger
我们可以将 express-list-endpoints 生成的路由列表与 Swagger 结合使用，这样可以更方便地进行 API 文档生成和测试。下面是一个示例：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------------- - ---------------------------------- ----- --------- - ------------------------------ ----- ------------ - ------------------------- ----- --- - ---------- ------------ ----- ---- -- - --------------- --------- --- -- ------ ----- --------- - ------------------- -- -- ------- -- ----- ------- - - ----------- - -------- -------- ----- - ------ --- ----- -------- -------- -- -- ----- - - -- ------ ------ ---------- -- ---------- -- ----- ------- -- -------- ------------------ -- -- -- ----- ----- - ---------------------- -- -- ------- -- -- --- -- -------------------- ---------------- ------------------------ ---------------- -- -- - -------------------- --- --------- -- ---- -------- ---展开代码
这个示例中，我们使用了 swagger-jsdoc、swagger-ui-express 这两个 npm 包来生成和显示 Swagger API 文档。在配置 options 时，我们将 express-list-endpoints 生成的路由列表引入了 paths 中，这样 Swagger 就可以使用这个列表来生成 API 文档。
结语
使用 express-list-endpoints，我们可以很方便地生成 express 应用中的路由列表，以方便调试和文档生成。同时，我们也可以将其与 Swagger 等其它工具结合使用，以实现更多的功能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/express-list-endpoints
