node-koa搭建MVC/RESTful API项目

本文将介绍如何基于node-koa搭建一个完整的mvc及restAPI的项目,项目封装了路由、模板引擎、 静态文件加载等基本功能;首先介绍项目的安装启动及目录结构说明,然后通过一个简单的登录页说明mvc的搭建和使用、通过一个人员表格的增删查改说明restAPI的搭建和使用,最后将简单说明各模块的实现方式;

完整项目地址: https://github.com/pangyongsheng/node-koa-REST-API   

查看效果:http://39.106.166.212:3000

                 http://39.106.166.212:3000/user

一、下载安装并启动项目

  下载:     git clone https://github.com/pangyongsheng/node-koa-REST-API.git

  切换到目录 :   cd koa

  安装依赖包:    npm install

  启动项目:   npm run start 

       访问:         http://127.0.0.1:3000/  

  界面如下:

  node-koa搭建MVC/RESTful API项目_第1张图片

二、项目目录结构说明

  koa        
  ├── app.js          服务启动文件 
  ├── controller.js   遍历controllers文件夹下全部接口文件添加到路由中
  ├── rest.js     封装restAPI返回数据处理,简化api写法--rest方法
  ├── templating.js  封装模板引擎载入view下模板文件,--render方法 
  ├── static-file.js  封装静态文件加载方法 
  │
  ├── controllers   该目录下放置所有接口文件,如:
      ├── api.js    restAPI接口
      ├── index.js   首页接口
      ├── ...
  ├── view       该目录下放置视图模板文件,可使用nunjucks模板语法:如
      ├── base.html   基础模板-header及footer 
      ├── index.html   首页
      ├── ...
  ├──server      该目录下放置数据处理类js文件:如抽取同类业务数据处理方法
      ├──server.js
      ├── ...
  ├──data       该目录下放置数据库处理文件
      ├──config.js   数据库配置文件
      ├── ...
  ├──static      改目录下放置前端静态文件,如一些前端类库、ui、及图片等
     ├──css
     ├──js
     ├──...
  ├── package.json

 

三、MVC搭建登录页

 

 1、编写页面代码

 (1)在view目录下创建base.html文件,编写页面页面头部和尾部的代码作为视图部分,在这里我们用到了nunjucks的模板语法,这样可以让其他的页面直接调用base.html的代码;

      node-koa搭建MVC/RESTful API项目_第2张图片

   页面代码如上图,这里面把文档申明及内的代码、