如果你是一位前端工程师，你一定知道 JSON API 是一个很有用的标准，用于自描述 RESTful API。在构建 RESTful API 的时候，使用 JSON API 可以方便地进行数据交换和存储。
generator-jsonapi-nodejs 是一个基于 Yeoman 的 npm 包，用于自动生成符合 JSON API 标准的 Node.js RESTful API。本文将介绍如何使用该 npm 包进行代码生成以及优化生成的代码以满足我们的需求。
安装 generator-jsonapi-nodejs
你需要先安装 Node.js，然后通过 npm 安装 generator-jsonapi-nodejs：
npm install -g yo generator-jsonapi-nodejs
生成代码
在命令行中进入你想要生成代码的目录，并输入以下命令：
yo jsonapi-nodejs
然后根据提示输入所需的信息，例如项目名称、数据库类型、数据库地址、端口号等等。完成之后，generator-jsonapi-nodejs 会自动生成你所需的代码。
示例代码
以下是一个基于这个 npm 包生成的简单 RESTful API 的示例代码。
安装依赖项
生成的项目需要安装依赖项，可以使用 npm 安装：
npm install
运行项目
运行生成的项目（默认使用端口号 3000）：
npm start
创建数据库模型
模型是对 JSON API 数据库表的定义，你可以在 app/models 文件夹中找到它们。
-- -------------------- ---- -------
----- -------- - --------------------
----- ------ - ----------------
----- ---------- - --- --------
------ -------
------- -------
------ -------
----- ------
---
-------------- - ---------------------- ------------创建控制器
控制器是用于处理 API 请求的逻辑，你可以在 app/controllers 文件夹中找到它们。
-- -------------------- ---- -------
----- -------- - --------------------
----- ---- - -----------------------
---------------------- - ------------- ---- -
------------- ------------- ----- -
-- ----- -
--------------
-
---------------
---
--
--------------------- - ------------- ---- -
----- -------- - --- ---------------
--------------------------- ----- -
-- ----- -
--------------
-
---------------
---
--
------------------- - ------------- ---- -
-------------------------------- ------------- ----- -
-- ----- -
--------------
-
---------------
---
--
--------------------- - ------------- ---- -
--------------------------- ------------------- --------- ----- ------ ------------- ----- -
-- ----- -
--------------
-
---------------
---
--
--------------------- - ------------- ---- -
----------------- ------------------- ------------- ----- -
-- ----- -
--------------
-
---------- -------- ----- ------------ -------- ---
---
--创建路由
路由用于将 API 路径映射到相应的控制器和函数上，你可以在 app/routes 文件夹中找到它们。
-- -------------------- ---- -------
----- ----- - --------------------------------
-------------- - ------------- -
-------------------
--------------------------
---------------------------
---------------------------
-----------------------
-------------------------
-----------------------------
--优化生成的代码
生成的代码可能不能完全满足我们的需求，例如认证、授权、日志记录等等。为了满足这些需求，我们需要手动地修改生成的代码。
增加认证和授权功能
你可以使用 Passport 实现认证和授权功能。安装 Passport 和相关策略：
npm install passport passport-jwt passport-local
在 app/config/passport.js 文件中配置 Passport：
-- -------------------- ---- -------
----- ----------- - ---------------------------------
----- ---------- - -----------------------------------
----- ------------- - -----------------------------------
----- -------- - --------------------
----- ---- - -----------------------
----- ------ - -------------------
-------------- - ------------------ -
-- --- ----
----- ---- - ---
------------------- - -----------------------------------------
---------------- - --------------
---------------- ----------------- --------------------- ----- -
----------------------------- ------------- ----- -
-- ----- -
------ --------- -------
-
-- ------ -
------ ---------- ------
- ---- -
------ ---------- -------
-
---
----
-- ------
---------------- ---------------
-------------- -------
-- --------------- --------- ----- -
-------------- ------ ----- -- ------------- ----- -
-- ----- -
------ ----------
-
-- ------- -
------ ---------- ------ - -------- ---------- ------- ---
-
------------------------------ ------------- -------- -
-- ----- -
------ ----------
-
-- ---------- -
------ ---------- ------ - -------- ---------- ---------- ---
-
------ ---------- ------
---
---
----
--在 app/controllers/authentication.js 文件中编写认证函数：
-- -------------------- ---- -------
----- --- - ------------------------
----- -------- - --------------------
----- ---- - -----------------------
----- ------ - ---------------------------
--------------- - ------------- ---- ----- -
----- -------- - --- ---------------
--------------------------- ----- -
-- ----- -
------ ----------
-
----- ----- - ------------- ---------- ---------------
------ ---------------------------- --------
---
--
--------------- - ------------- ---- ----- -
-------------- ------ -------------- -- ------------- ----- -
-- ----- -
------ ----------
-
-- ------- -
------ ---------------------- -------- --------------- ------- ---- --- ------- ---
-
--------------------------------------- ------------- -------- -
-- ----- -
------ ----------
-
-- ---------- -
------ ---------------------- -------- --------------- ------- ----- ---------- ---
-
----- ----- - ------------- ---------- ---------------
------ ---------------------------- --------
---
---
--然后在相应的路由中添加认证中间件，并在控制器中检查用户权限。
-- -------------------- ---- -------
----- -------- - --------------------
-------------- - ------------- -
----- ----- - --------------------------------
----- ---- - -----------------------------------------
-- -----
---------------------
--------------------
---------------------
--------------------
-- ----
-------------------------------
-------------------
--------------------------------- - -------- ----- --- ---------------------
---------------------------------- - -------- ----- --- ---------------------
---------------------------
--------------------------------- - -------- ----- --- ------------------
--------------------------------- - -------- ----- --- --------------------
------------------------------------ - -------- ----- --- ---------------------
--添加日志记录
你可以使用 Morgan 记录服务器请求的日志。安装：
npm install morgan
在 app/config/index.js 文件中添加配置：
-- -------------------- ---- -------
----- ------ - ------------------
-------------- - -
-- ---
------ -
----- --- - ----------
-----------------------
-- ---
-
--其它优化
除此之外，你还可以添加：
- 校验请求参数：
- 处理异常：
- 处理重复的错误处理代码：
总结
generator-jsonapi-nodejs 可以让我们快速地生成符合 JSON API 标准的 Node.js RESTful API，从而让我们能够更加专注于业务逻辑的实现。然而，生成的代码不能完全满足我们的需求，我们还需要添加认证、授权、日志记录等等功能。通过手动修改生成的代码，我们可以自定义地实现这些功能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005620781e8991b448df745