# mini-mock

**Repository Path**: shore1ot/mini-mock

## Basic Information

- **Project Name**: mini-mock
- **Description**: 基于 express+jade 的简易动态接口模拟服务
- **Primary Language**: NodeJS
- **License**: MulanPSL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-12-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mini-mock

#### 介绍
基于 express+jade 的简易动态接口模拟服务

#### 安装教程

1.  npm i
2.  nodemon start

#### 使用说明

1.  在`routes/config.json`中：
```
{
    /* 配置接口列表 */
    "interface": [
        {
            /* 接口id<必须唯一> */
            "id": "2",
            /* 接口地址<必须唯一> 通过IP+端口号+url访问 如192.168.1.0:3000/login */
            "url": "/login",
            /* 接口备注 */
            "description": "登录测试",
            /* 请求方式 */
            "method": "POST",
            /* JSON入参 */
            "params": [
                {
                    /* 参数字段名称 */
                    "name": "username",
                    /* 参数字段备注 */
                    "description": "用户名",
                    /* 是否必填 */
                    "require": true
                },
                {
                    "name": "password",
                    "description": "密码",
                    "require": false
                }
            ],
            /* JSON出参 */
            "output": {
                "code": 200,
                "message": "登录成功"
            }
        }
    ]
}
```
2.  可启动服务后在浏览器中输入域名即可在局域网中访问可视化接口文档