简介
typescript-rest 是一个 TypeScript 库，它使用装饰器语法来快速开发基于 Express 或 Restify 的 Web 服务。它可以使开发人员编写可维护和易于测试的路由，而无需编写大量的样板代码。这篇文章将介绍 typescript-rest 的基础知识，并提供一些示例代码来帮助您快速入门。
安装
安装 typescript-rest 很简单，只需在终端窗口中运行以下命令：
$ npm install typescript-rest
使用
假设您已经有一个 Express 或 Restify 应用程序。您可以使用 typescript-rest 去创建控制器，这样就可以将该控制器的方法映射到 HTTP 端点。例如，下面是一个简单的控制器：
-- -------------------- ---- ------- ------ - --------------- --- - ---- ------------------ -------------------- ------ ----- -------------------- - -------------- ----------- ------ - ------ ------- -------- - -展开代码
在这个例子中，我们定义了一个叫做 HelloWorldController 的控制器，并使用 @RestController 装饰器指定了该控制器的路径为根路径。我们还在 sayHello 方法上使用了 @Get 装饰器来将该方法映射到 /hello HTTP 端点。当客户端连接到该端点时，它将返回字符串 Hello, world!。
如果您已经有了一个 Express 或 Restify 应用程序，则可以像下面这样将 HelloWorldController 添加到它上面：
import * as express from 'express'; import HelloWorldController from './controllers/HelloWorldController'; const app = express(); app.use('/api', HelloWorldController);
控制器
控制器是 typescript-rest 中的核心概念。您可以通过定义控制器将 HTTP 端点映射到类中的方法。要使用 typescript-rest 创建控制器，请首先创建一个类，并使用 @RestController 装饰器将其标记为控制器。
import { RestController } from 'typescript-rest'; @RestController('/') export class HelloWorldController { }
在这个例子中，我们定义了一个叫做 HelloWorldController 的控制器，并使用 @RestController 装饰器指定了该控制器的路径为根路径。
方法
一旦我们创建了一个控制器，我们可以开始为其添加方法。在这里，我们使用 @Get、@Post、@Put、@Delete 和 @Patch 装饰器来指定将哪个 HTTP 方法映射到该方法。
-- -------------------- ---- ------- ------ - --------------- ---- ----- ---- ------- ----- - ---- ------------------ -------------------- ------ ----- -------------------- - --------- --------- --- - -- --- - ------------ ---------- -------- --- - -- --- - ---------- ------------ ----- --- - -- --- - ------------ ---------- ------- ----- ----- --- - -- --- - --------------- ---------- -------- --- - -- --- - -------------- --------- ------- ----- ----- --- - -- --- - -展开代码
在这个例子中，我们定义了 6 个不同的方法，并使用 @Get、@Post、@Put、@Delete 和 @Patch 装饰器分别指定它们将映射到哪个 HTTP 方法。注意，我们可以在路径中使用变量，如 /:id。这将在调用方法时提供变量值。
中间件
有时候，在具体的路由方法执行前，我们需要执行一些中间件，一般是一些通用的业务逻辑层面的处理，例如身份认证等。typescript-rest 可以很方便地支持中间件的使用。只需要在类级别的控制器上使用一个或多个 @Middleware 装饰器，即可为该类的所有路由方法添加中间件。
-- -------------------- ---- ------- ------ - --------------- ---- ---------- - ---- ------------------ -------- --------- ---- ----- - -- --- ------ --- ------- - -------------------- ----------------- ------ ----- -------------------- - -- --- -展开代码
在这个例子中，我们定义了一个 auth 中间件函数，并在 @Middleware 装饰器中使用它来将其添加到控制器 HelloWorldController 上。当任何该控制器的路由方法被调用时，该中间件都会先被执行。
结论
在本文中，我们已经简要地介绍了 typescript-rest 的一些基本概念和原理。typescript-rest 可以大大简化基于 Express 或 Restify 的 Web 服务的开发过程，是一个非常有用的库。如果您正在进行 Web 服务的开发，并希望提高生产效率和代码质量，那么 typescript-rest 绝对是值得一试的。
示例代码
-- -------------------- ---- ------- ------ - -- ------- ---- ---------- ------ - --------------- ---- ----- ---- ------- ------ -------- --------- ---------- - ---- ------------------ -------- --------- ---- ----- - -- --- ------ --- ------- - -------------------- ----------------- ------ ----- -------------------- - --------- ----------------- ---- ---------------- ----------- ---- ------------------ --- - -- --- - ------------ ----------------- ---- ---------------- ----------- ---- ----------------- --- -------- --- - -- --- - ---------- ----------------- ---- ---------------- ----------- ---- ----------------- ----- ----- --- - -- --- - ------------ ----------------- ---- ---------------- ----------- ---- ----------------- --- ------- ----- ----- --- - -- --- - --------------- ----------------- ---- ---------------- ----------- ---- ----------------- --- -------- --- - -- --- - -------------- ---------------- ---- ---------------- ----------- ---- ----------------- --- ------- ----- ----- --- - -- --- - - ----- --- - ---------- --------------- ----------------------展开代码
这里是 typescript-rest 库的一个简单示例，其中包含了一个控制器、中间件、路径变量等等。这个示例可以帮助您快速入门，并开始用 typescript-rest 编写 Web 服务。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/79771
