Springwlt / node-mocha

Node Rest Api

A simple template for building a node restful api service

技术栈

• nodejs
• express
• mongodb
• mocha
• swagger-jsdoc

项目简介

• 使用ES6/ES7特性
• 使用ESlint进行语法检测，遵循Airbnb JavaScript Style Guide
• 使用swagger-doc管理文档. Visualize document using Swagger UI.

开发、测试、打包命令

# mongodb config
# config locate in: src/config.js
mongodb: {
  host: 'localhost',
  database: 'example'
}
# or you can add an mongodb account for security
mongodb: {
  host: 'localhost',
  database: 'example',
  user:'user',
  password:'pwd'
}
# 安装依赖
yarn

# 运行
npm run start

# 构建
npm run build

# 测试
npm run test

DOC

you can visualize the doc and test the api using Swagger Doc through web browser.

URL are as below

http://swagger.daguchuangyi.com/?url=http://localhost:8888/swagger.json#!

项目结构

/src              项目源码文件夹
  /models         使用mongoose定义的model的目录
  /routes         项目路由文件目录
  /utils          封装的工具函数目录
  config.js         配置文件
  log.js            export了一个log模块
  main.js           程序入口文件
package.json      
README.md
.babelrc
.eslintrc