简介
generator-mean2-app-api 是一个基于 Yeoman 的 npm 包,可以快速搭建 MEAN(MongoDB,Express,Angular,Node.js)栈的应用程序 API 后端。使用 generator-mean2-app-api 可以方便地创建一个带有 CRUD 操作的 RESTful API,让开发者专注于业务逻辑而不是底层架构。
准备工作
首先,需要提前准备好以下工具和环境:
- Node.js
- MongoDB
安装 generator-mean2-app-api
可以通过 npm 命令安装 generator-mean2-app-api:
npm install -g yo generator-mean2-app-api
使用 generator-mean2-app-api
在终端里,进入你要创建项目的文件夹,输入以下命令开启创建过程:
yo mean2-app-api
此时会提示用户输入项目名称,按照提示进行输入。此时会自动下载项目模板和相关依赖。
创建完成后,项目结构大概是这个样子:
-- -------------------- ---- ------- - --- ------ - --- --------- - --- --- - - --- -------------- - - --- -------- - - --- ------------- - - --- ------- - --- ---------- --- ----------- - --- -------- - --- ------- --- ------ - --- -------- - --- ------- --- ------ - --- -------- - --- ------- --- ---- --- -------------- --- ---------- --- ------ --- ----------------- --- ------------ --- --------- --- ---------
下面对主要的文件和文件夹作简要说明:
- config:存放应用程序的配置文件和框架配置文件。
- controllers:存放控制器文件。
- models:存放模型文件。
- routes:存放路由文件。
其中,controllers,models,routes 目录下的文件都是默认生成的 user 例子文件,可根据自己的需求进行修改或创建新的文件。
使用示例
连接 MongoDB
在 config/config.js 文件中,打开注释,将 mongoUri 配置为本地 MongoDB 的 URI:
module.exports = { ... mongoUri: 'mongodb://localhost/mean2', ... }
运行应用程序
在终端里运行以下命令,即可开启 API 服务器:
npm start
然后,在浏览器里打开 http://localhost:3000/api/users,可以看到如下结果:
{"message":"No user found.","data":[]}
创建新的用户
可以使用 curl 命令向服务器发送 POST 请求,添加一个新的用户:
curl -X POST -H 'Content-Type: application/json' -d '{"name":"Tom","email":"tom@example.com","username":"tommy","password":"password123"}' 'http://localhost:3000/api/users'
如果一切正常,服务器应该返回如下结果:
-- -------------------- ---- ------- - ---------- ----- ----- --------------- ------- - ------ --------------------------- ------- ------ -------- ------------------ ----------- -------- ----------- -------------- ------------- --------------------------- ------------- --------------------------- ------ - - -
查询用户
向服务器发送 GET 请求,查询所有用户:
curl -X GET 'http://localhost:3000/api/users'
如果成功,服务器应该返回所有的用户列表。
修改用户
向服务器发送 PUT 请求,修改用户信息:
curl -X PUT -H 'Content-Type: application/json' -d '{"name":"Tommy Lee","email":"tommy@example.com"}' 'http://localhost:3000/api/users/5e3c3z8k2bzoya253573a03c'
服务器应该返回如下结果:
-- -------------------- ---- ------- - ---------- ----- ---------- ------- - ------ --------------------------- ------- ------ ----- -------- -------------------- ----------- -------- ----------- -------------- ------------- --------------------------- ------------- --------------------------- ------ - - -
删除用户
向服务器发送 DELETE 请求,删除用户:
curl -X DELETE 'http://localhost:3000/api/users/5e3c3z8k2bzoya253573a03c'
如果成功,服务器应该返回如下结果:
-- -------------------- ---- ------- - ---------- ----- ------- --------------- ------- - ------ --------------------------- ------- ------ ----- -------- -------------------- ----------- -------- ----------- -------------- ------------- --------------------------- ------------- --------------------------- ------ - - -
总结
在本教程中,我们学习了如何使用 generator-mean2-app-api 这个 npm 包,快速搭建 MEAN 栈的应用程序 API 后端,并向服务器发送各个 HTTP 请求进行数据操作,也提供了样例代码来供读者参考使用。虽然初始过程有些复杂,但使用后却有着很大的优势和便利性,有助于帮助开发者快速搭建起应用程序 API 后端架构,专注于业务逻辑而不是底层架构。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600559e681e8991b448d78a6