npm 包 @d0whc3r/typescript-rest 使用教程

前言

在前后端分离的开发模式中，前端工程师需要在编写页面的同时与后端进行数据交互。而 TypeScript 是 JavaScript 的一个超集，提供了类型检查和更好的代码提示，能够帮助前端工程师更高效地编写代码。@d0whc3r/typescript-rest 是一个基于 TypeScript 的 RESTful API 框架，可以帮助前端工程师更快地开发出符合 RESTful 规范的 API。

安装

使用 npm 安装 @d0whc3r/typescript-rest：

npm install @d0whc3r/typescript-rest

使用方法

1. 建立一个 HelloController.ts 文件，定义一个控制器类：

   -- -------------------- ---- -------
   ------ - --------------- --- - ---- ---------------------------
   
   ------------------------
   ------ ----- --------------- -
       ------
       ----------- ------ -
           ------ ------- ------------------
       -
   -

   上述代码定义了一个名为 hello 的控制器，并在控制器中实现了一个 GET 请求的 API，其返回值为一个字符串。

2. 在 index.ts 文件中启动应用：

   import { Server } from '@d0whc3r/typescript-rest';
   import { HelloController } from './controllers/HelloController';
   
   const server = new Server();
   server.addControllers(new HelloController());
   server.start();

   上述代码在应用中添加了一个 HelloController，并启动了应用。

   启动应用后，访问 http://localhost:3000/hello，将会看到浏览器中输出了 Hello, TypeScript-REST!。

指南

控制器

控制器是一个类，用于处理 API 的各种请求。在 @d0whc3r/typescript-rest 中，一个控制器可以包含多个 API。

定义一个控制器需要满足以下要求：

1. 类必须被 @RestController 装饰器修饰。
2. @RestController 装饰器接收一个字符串类型的参数，表示控制器的路由前缀（不必以 / 开头）。

定义一个控制器：

import { RestController } from '@d0whc3r/typescript-rest';

@RestController('example')
export class ExampleController {}

上述代码定义了一个名为 example 的控制器。

API

API（Application Programming Interface，应用程序编程接口）实现了控制器处理请求的逻辑。在 @d0whc3r/typescript-rest 中，API 可以是一个方法，它必须被放置在控制器内。

定义一个 API 需要满足以下要求：

1. API 的方法名必须符合 HTTP 请求方式的规范。比如，GET 请求必须定义名为 get 的方法，POST 请求必须定义名为 post 的方法。
2. 每个 API 必须被装饰器修饰。

定义一个 GET 请求 API：

-- -------------------- ---- -------
------ - --------------- --- - ---- ---------------------------

--------------------------
------ ----- ----------------- -
    ------
    ------ ------ -
        ------ ---- ---------
    -
-

上述代码定义了一个 get 方法，返回一个字符串。

完成定义后，在应用中添加控制器：

import { Server } from '@d0whc3r/typescript-rest';

const server = new Server();
server.addControllers(new ExampleController());
server.start();

启动应用后，访问 http://localhost:3000/example，将会看到浏览器中输出了 get request。

示例代码

完整的示例代码（使用 express 作为监听器）：

-- -------------------- ---- -------
------ - ------ - ---- ---------------------------
------ ------- ---- ----------

----- --- - ----------
----- ------ - --- --------
    ----------- ----
    ----- -----
---

----- --------------- -
    ------
    ------ ---------- -
        ------ ------- ------------------
    -
-

------------------------- -------------------
---------------

通过以上代码，启动应用后，访问 http://localhost:3000，将会看到浏览器中输出了 Hello, TypeScript-REST!。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/109928