前言
在开发 Web 应用时，我们常常会遇到需要查看接口文档的情况。而 express-list-endpoints 是一个非常优秀的 express 插件，能够自动扫描 express 应用、挂载的路由及中间件，生成对应的路由信息，并输出成 JSON 格式或者 HTML 文档，方便我们查看。
但是当我们在 TypeScript 的项目中使用这个插件时，可能会遇到类型定义不兼容的问题。那么这个时候，就需要用到另一个 npm 包：@types/express-list-endpoints。本文主要介绍如何使用这个 npm 包。
安装
对于开发者而言，无论是 JavaScript 还是 TypeScript 项目，我们都需要安装 express-list-endpoints 以及 @types/express-list-endpoints 这两个 npm 包。
使用 npm 安装：
npm install express-list-endpoints @types/express-list-endpoints --save-dev
使用 yarn 安装：
yarn add express-list-endpoints @types/express-list-endpoints -D
使用 @types/express-list-endpoints
在我们安装好了 @types/express-list-endpoints 这个 npm 包后，我们可以在 TypeScript 的项目中，对 express-list-endpoints 进行类型检查。下面是一个使用示例：
-- -------------------- ---- ------- ------ -------- - -------- -------- - ---- ---------- ------ -------------- - --------------------- - ---- ------------------------- ----- --- - ---------- ------------------------ ------------ ----- -------- ---- --------- -- - ---------------- --------- --- --------------- ----- -------- ---- --------- -- - ----- --------- - ------------------ -- ---------------------- -------------------- --- ---------------- -- -- - ------------------- -- ------- -- ---- -------- ---展开代码
在上面的示例中，我们首先导入了 express 和 @types/express-list-endpoints 中的类型定义。然后，我们定义了一个 express 应用实例 app，并挂载了一个简单的路由 /，用来返回一个 “Hello, world!” 的字符串。
接着，我们定义了一个 /api 路由，并使用 listEndpoints(app) 这个方法来获取整个 express 应用的路由信息，并将其作为 JSON 格式返回。需要注意，我们需要将 listEndpoints(app) 的返回值转换成 EndpointsDescriptions 类型，这时 TypeScript 就可以进行类型检查了。
最后，我们启动了一个监听端口为 3000 的服务器，并在控制台中输出了一条消息。
总结
在本篇文章中，我们介绍了 npm 包 @types/express-list-endpoints 的使用方法以及其在 TypeScript 项目中的应用。通过此包，我们可以让 TypeScript 代码中的每一行都有类型检查的保障，避免出现类型不兼容的问题。希望能对使用 TypeScript 进行 express 开发的开发者们有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/the-types,-express-the-list-of-endpoints
