node---express脚手架的后端接口

四、express电商项目之-接口

4.1 创建项目

基于node的项目的脚手架： koa express

// 确保安装 express 脚手架  ----  只需要一次即可
cnpm / npm install express-generator -g

// 创建项目  ---  需要选择模板语言 ejs / jade / pug .....
express admin-app

cd admin-app
// 安装依赖   ----  比不可少（查看有无node_modules文件夹）
cnpm / npm i         /   yarn

// 运行项目  ----  查看package.json ，找到运行命令 scripts
cnpm / npm run start    /    yarn start

// 当修改源文件时，每次都需要重新启动服务器  nodemon / supervisor

cnpm / npm i supervisor -g // 只需一次

// 修改package,json 添加运行命令  dev

"scripts": {
    "start": "node ./bin/www",
    "dev": "supervisor ./bin/www"
},

// 运行命令
cnpm / npm run dev

4.2 创建相应的接口文件

在项目的根目录下创建 api 文件夹，用于存放接口文件

？？？ 为什么不在routes下创建接口文件

api ---- 接口文档 --- 前端开发人员

routes --- 界面--运维人员

• 首页 - 搜索、轮播图、nav导航、热推产品、产品的列表（下拉刷新，上拉加载、回到顶部）

search、banner、nav、pro

• 分类 - 大分类 - 品牌分类 - 产品列表

category

分类页面点击某一个选项 进入 搜索页面 ---- 排序或者筛选的相关接口

筛选页面点击进入 产品的详情 --- 商品简单介绍、评价、图文详情、猜你喜欢

comment

加入购物车，必须得先登陆，必须得先注册，购物车操作、提交订单,支付、评论

users、cart、order

让这些接口文件全部生效 --- app.js中引入接口以及注册接口 - 记得重新启动服务器

浏览器输入测试接口的可用性

4.3 编写接口文档

• 安装需要的依赖

cnpm / npm i apidoc -g

• 在public文件夹内部生成接口文档 - apidoc的文件夹

• 修改package.json文件，添加如下代码

• api/pro.js中配置接口文档
  

运行如下命令，生成接口文档

apidoc -i api/ -o public/apidoc/

浏览器访问 http://localhost:3000/apidoc/ 查看接口文档

4.4 创建相应的数据库集合

• 项目根目录下创建 sql/db.js
  

• 打开数据库的连接池，找到mongodb的安装目录，找到bin目录下，指定数据库存放的位置 （d:\data\db）,运行命令如下
  

mongod --dbpath d:\data\db

• 项目安装 mongoose,封装数据库连接模块

cnpm i mongoose -S

补充：-g --global -S --save -D --save-dev

• 创建需要的集合

sql/col 文件夹下创建对应的 接口的 数据库集合

col/banners.js - 轮播图数据库集合

col/pros.js - 数据列表的集合

 

 

-------------------------------------------------------文章来自吴大勋（大勋说）