# mexp

**Repository Path**: jojowwbb/mexp

## Basic Information

- **Project Name**: mexp
- **Description**: 基于Express搭建的Rest接口开发框架
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: mexp-lib
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2017-03-17
- **Last Updated**: 2021-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


## 基于Express搭建的Rest接口开发框架


基于Express开发的接口服务开发框架
用于快速开发接口、采用sql model配置文件的形式加载接口

依赖：
 *  mysql
 *  express
 *  bodyParser
 *  cors
 *  helmet
 *  morgan


### 使用

>   安装

    npm install

>   使用nodemon来自动重启项目、便于开发

    npm run dev:hot

>   使用pm2来守护进程
>   开发自动编译环境(由于使用ES6的语法特性、所以需要babel-node命令来启动、需要全局安装babel-cli)

    npm run start //启动服务

>   编译代码

     npm run build //编译代码

>   手动开发编译、每次修改代码后都要手动重新编译

    npm run dev




### 目录说明

    -src

        -lib    //第三方库封装目录

        -server //业务逻辑模块、数据库操作模块

        -rest   //rest接口模块

            * common.js //提供了一个常用模块：文件上传

        * app.js //应用入口文件

    -logs   //项目运行日志目录

    -build  //编译后的代码目录（es6 => es5）

    -config //项目公共配置文件目录

        -config.json

        -log4js.json //日志管理包配置文件

        -sql.json //sql查询字符串 映射文件

    * log4js.json //日志模块配置文件

    * .babelrc //babel插件配置文件

    * process.json //pm2进程管理配置文件

    * .gitignore


### 开发说明

#### 文件路径使用方式：

当前路径：

    path.dirname(__filename)+'/文件路径'

其他路径

    path.resolve(__dirname,'相对当前文件的路径')


#### model配置说明：

    {
        key:{
                        name:"接口名称",
                        sql:"sql字符串",
                        path:"",
                        query:""
                    }
    }

`key` 接口前缀路径,如：GET#/user

>   `name` 接口名称、非必填项

>   `sql` sql字符串、必填

>   `path` 路径查询字段数组、非必填项

>   `query` url查询字段数组、非必填项