介绍
bews-koa-joi-swagger 是一个能够帮助前端开发者快速构建 RESTful API 服务的 npm 包，它能够自动生成 swagger 文档，并提供简洁易用的 Joi 验证功能，以及错误处理能力，可以轻松地帮助开发者将业务逻辑与验证逻辑分离。
安装
npm install bews-koa-joi-swagger --save
使用
初始化
首先，我们需要使用 bews-koa-joi-swagger 初始化一个 Koa 实例，代码如下：
-- -------------------- ---- -------
----- --- - ---------------
----- ------ - ------------------------
----- ---------- - --------------------------
----- - ----------- - - --------------------------------
----- --- - --- ------
----------------------
----- ----------- - -
------------------ -
----- -
------ --- -----
-------- --------
------------ --- --- ---------------
--
--------- ----
--------- -------------------- -------------------
-------- -------- ---------
--
----- ------------------
--
----- --------- - ---------------- -------------
-------------------
-------------------------
---------------------------------在这段代码中，我们首先引入了 Koa、koa-router、koa-bodyparser 和 bews-koa-joi-swagger，然后通过 new Koa() 创建了一个 Koa 实例，并通过 app.use(bodyParser()) 使用了 koa-bodyparser 中间件。
接着，我们定义了 swaggerOpts 对象，这是给 Swagger 接口文档使用的配置项，里面包括 SWagger 文档的基本信息和定义的接口文件路径，apis 属性中的文件路径需要根据实际情况进行修改。
最后，我们调用了 initSwagger(app, swaggerOpts) 方法将 Swagger 接口文档应用到了 Koa 中，并将其使用到了对应的路由中。
路由处理
为了 better-util-joi-wrapper-plugins 的结构尽量平铺，没有统一的 response 格式，所以没搭配 responseBody。因此，你需要在你的业务接口里自行处理 ctx.response.body 的返回值。
我们操作的这个应用真实的业务逻辑在路由处理中完成，接下来，我们编写一个 GET 请求的路由示例，获取用户信息：
-- -------------------- ---- -------
----- --- - ---------------
------------------------ ----- ----- -- -
----- ------ - --------------
----- ------ - -------------------
--- --------------------------------------------------
---
----- - ----- - - -------------- --- ------ -- --------
-- ------- -
-------- - - -------- ------------------------ --
---------- - ----
-------
-
----- ---- - ----- -------------- --- ------ ---
-- ------- -
-------- - - -------- ----- --- ------- --
---------- - ----
-------
-
-------- - -----
---------- - ----
---在这段代码中，我们首先引入了 Joi 并定义了一个字符串的参数验证规则，然后根据 GET 请求的参数中的 id，使用 Joi 验证参数的合法性，并判断参数验证是否通过。如果参数验证不通过，则返回状态码 400 和错误信息。如果参数验证通过，则查询数据库，如果未查询到数据，则返回状态码 404 和错误信息，如果查询到了数据，则将其返回，同时设置状态码为 200。
启动服务器
在上文中，我们提到了 bews-koa-joi-swagger 可以帮助我们生成 Swagger 接口文档，现在我们可以将上面的代码保存为一个文件，例如 server.js，然后通过以下命令启动 Koa 服务器：
node server.js
然后，我们可以访问 Swagger 接口文档，它的地址为：http://localhost:3000/docs。
结论
bews-koa-joi-swagger 可以大大提高前端开发者的开发效率，让他们能够快速地构建 RESTful API 服务并生成文档，同时也提供了 Joi 验证等实用功能，可以为他们的开发工作提供极大的便利。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055b8881e8991b448d926d