npm 包 @arietrouw/rest 是一个基于 Node.js 开发的 RESTful API 实现模块。它提供了一套简单易用的接口，开发者可以在应用或者服务中快速搭建 RESTful API。
安装
首先，我们需要在项目根目录中安装 @arietrouw/rest 模块。使用 npm 命令行工具：
npm install @arietrouw/rest --save
这将通过 npm 安装 @arietrouw/rest 模块，并将其添加到项目的 package.json 将文件中的依赖中。
使用
使用 @arietrouw/rest 模块非常简单，只需要在代码中引入该包并设置路由即可。
下面是一个基本示例：
-- -------------------- ---- -------
----- ------- - -------------------
----- - ---- - - ---------------------------
----- --- - ----------
----- ---- - --- ----------
---------------------- -
-------- ---- -
------ ---------- ------ -- ----- ------- -- ------ ------- -------- -------- ---
--
--------- ---- -
------ -------------------------- ----------
--
-------- ---- -
------ -------------------------- ----------
--
----------- ---- -
------ -------------------------- ----------
--
---
---------------- -- -- -
-------------------- --- --------- -- ---- --------
---上面这个示例创建了一个基本的 RESTful API /book，在浏览器中访问 http://localhost:3000/book 将能够得到一个 JSON 数据 { title: 'A Brief History of Time', author: 'Stephen Hawking' }。
API
Rest 类的公共实例方法如下：
构造函数
new Rest(app: express.Application, options?: Object)
app- Express 应用实例
静态方法
parseQuery(query: string)
解析查询参数为一个对象。如 ?page=2&size=10 将被解析为 { page: 2, size: 10 }。
实例方法
resource(path: string, methods: Object)
为指定的路由路径 path 创建 RESTful API，指定的 HTTP 方法由 methods 参数指定。HTTP 方法将自动映射到相应的操作方法上。方法名称和 HTTP 方法一样。
下面是一个示例：
-- -------------------- ---- -------
---------------------- -
-------- ---- -
------ ---------- ------ -- ----- ------- -- ------ ------- -------- -------- ---
--
--------- ---- -
------ -------------------------- ----------
--
-------- ---- -
------ -------------------------- ----------
--
----------- ---- -
------ -------------------------- ----------
--
---register(method: string, path: string, handler: Function)
注册自定义的 RESTful API 路由。
rest.register('get', '/book/:id', (req, res) => {
return res.send({ bookId: req.params.id, title: 'The Hitchhiker\'s Guide to the Galaxy', author: 'Douglas Adams' });
});registerNotFoundError(handler: Function)
注册路由未找到错误。
rest.registerNotFoundError((req, res) => {
return res.status(404).send({ message: 'Resource not found' });
});总结
本文介绍了 @arietrouw/rest npm 包的安装和使用方法，以及其大部分 API。读者可以根据自己的需求自由使用和扩展该模块，快速开发 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/141944