nodejs编写测试接口

node启动地址：http://10.1.62.116:55555/

github地址：https://github.com/huangyangteng/node-simple-server.git

[toc]

项目说明

本项目用于为拨测项目提供测试接口，采用原生nodejs编写，数据统一储存在文件中，为减少代码编写量，文件操作均采用同步方式。

项目结构

server.js         ---------------启动服务器
Controller.js     --------------- 所有的接口逻辑合集
MAP_URL.js        --------------- url与接口逻辑的对应管理
data              --------------- 数据，使用.json文件储存
api               --------------- 接口逻辑分模块划分

项目启动

开发环境启动

使用nodemon工具进行调试，保存后自动执行

nodemon server.js

生产环境启动

# 启动服务为进程
pm2 start server.js --name node-monitor
# 查看日志
pm2 log
# 杀死进程
pm2 delete node-monitor
# 重启服务
pm2 restart node-monitor

编写接口流程

接口规范

后台处理的请求格式为 json 格式，即Content-type:application/json
后台响应的数据格式也为json格式

说明

get请求的参数，这种形式：'?name=ming&pass=12'从req.query中取到
get请求的参数，这种形式：'/user/123'从req.params中取到
post请求的参数从req.data中取到
数据使用文件保存，不使用数据库

流程-例子

以角色管理为例，接口文档如下：

第一步新建数据

在data目录下新建role.json

第二步编写接口

在api目录下新建role.js,引入相应依赖，并导出role对象

const fs=require('fs')

const Res=require('./resCommon')



const role={
	all(){//获取所有角色
        let resData=JSON.parse(fs.readFileSync('data/role.json').toString())
        return Res.success(resData)
  },
  add(){//增加一条数据
    
  }
}

module.exports=role

第三步在`Controller.js`中导入并导出该接口

Controller.js文件统一管理所有接口

const administrator=require('./api/administrator')
const task=require('./api/task')
const error=require('./api/error')
const role=require('./api/role')
const province=require('./api/province')

const Controller={
    administrator,
    task,
    error,
    role,
    province
}
module.exports=Controller

第四步建立url和接口的映射关系

在MAP_URL.JS文件中建立url和接口的映射关系

const Controller=require('./Controller')

function getMapKey(map,url){
    for(var key in map){
        if(url==key){///匹配顺序 user -> /user/add ->/login.html 
            return key
        }else if(url.indexOf(key) != -1){
            return key
        }
    }
}

const {administrator,role} =Controller

const MAP_URL={//顺序很重要 遍历时是按照顺序进行的  /user /user/add 
    '/api/administrator/login':administrator.login,
    '/api/role/all':role.all, // url以/api/role/all开头时，执行role.all方法
    '/api/role/add':role.add,
}

module.exports={
    MAP_URL:MAP_URL,
    getMapKey:getMapKey
}

huangyangteng/node-simple-server