简介
circe-controller 是一个基于 Circe 框架封装的一个 controller 生成工具。它可以将 controller 和 service 层的模版代码封装成一个脚手架,方便我们快速生成通用的 RESTful API 请求接口。
安装
我们可以通过 npm 进行安装:
npm install -g circe-controller
这样就可以全局调用 circe-controller 命令。
使用
生成 Controller
在终端中执行以下命令生成 Controller:
circe-controller make:controller [Controller 文件名] [Service 文件名] [HTTP Method] [API URL]
例如,要生成 UserController
的 index
接口:
circe-controller make:controller UserController UserService GET /users
执行完命令后,我们就可以在项目的 src/app/controller
目录下找到生成的 Controller 文件。
生成 Service
在终端中执行以下命令生成 Service:
circe-controller make:service [Service 文件名]
例如,要生成 UserService
的 Service 文件:
circe-controller make:service UserService
执行完命令后,我们就可以在项目的 src/app/service
目录下找到生成的 Service 文件。
示例
我们在 circe 应用的根目录下 npm init
然后通过以下命令来创建一个 circe 应用:
mkdir myapp && cd myapp && npm init -y && npm install circe
接下来,我们使用 circe-controller
创建一个 UserController:
circe-controller make:controller UserController UserService GET /users
执行完毕后,我们在 src/app/controller/UserController.js
文件中看到如下生成的代码:
-- -------------------- ---- ------- ----- - -------------- - - ---------------- ----- - ----------- - - --------------------------------- ----- -------------- ------- -------------- - ----- ----- -- - ----- - ------ ------ - - -------------- ----- ----- - ----- --------------------- ------ -------------- ------- -------------- -- ------------------ - - -------------- - --------------
同时,在 src/app/service
目录下看到生成的 UserService
文件:
class UserService { static async findAll () { // Your code here } } module.exports = { UserService }
此时,我们只需要根据业务逻辑补充代码即可。
结语
circe-controller 可以快速生成通用的 RESTful API 请求接口,提高我们的代码开发效率,同时减少手工开发代码的重复率,是我们前端开发过程中十分实用的一款工具。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cda81e8991b448e6843