github.com/kumasuke120/mockuma@v1.1.9/README_CN.md (about)

     1  # MocKuma [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Release](https://img.shields.io/github/release/kumasuke120/mockuma/all.svg)](https://github.com/kumasuke120/mockuma/releases/latest) [![Build Status](https://api.travis-ci.org/kumasuke120/mockuma.svg?branch=dev)](https://travis-ci.org/kumasuke120/mockuma) [![codecov](https://codecov.io/gh/kumasuke120/mockuma/branch/dev/graph/badge.svg)](https://codecov.io/gh/kumasuke120/mockuma)
     2  
     3  [[English](README.md) | 中文]
     4  
     5  MocKuma 是一款 API 接口的 Mock 工具。该工具读取命令化的 Json 映射配置文件，并根据配置生成对应的 Mock 接口。
     6  
     7  前、后端开发人员使用本工具可以模拟 RESTful 接口以辅助开发以及单元测试； 
     8  测试人员也可以使用本工具利用其命令式的映射配置进行参数匹配编写符合测试用例的接口辅助测试。
     9  
    10  ### 特性
    11  - 根据请求参数/请求头映射返回
    12  - 映射改变时，自动重新加载
    13  - 使用用户定义的模板和变量渲染映射
    14  - 支持静态文件引用
    15  - 支持跳转和转发
    16  
    17  
    18  ## 安装
    19  执行以下命令以在你的环境中安装 MocKuma
    20  ```
    21  $ go get -u github.com/kumasuke120/mockuma/cmd/mockuma
    22  ```
    23  
    24  如果想要避免麻烦或者没有 Go 的开发环境，请[点此](https://github.com/kumasuke120/mockuma/releases)以下载已发布版本的可执行文件。
    25  
    26  
    27  ## 快速开始
    28  
    29  1. 确认 `$GOPATH\bin` 已经被添加到你的 `$PATH` 环境变量中；
    30  2. 创建名为 `mockuMappings.json` 的文件，内容如下：
    31  ```json
    32  [
    33    {
    34      "uri": "/",
    35      "method": "GET",
    36      "policies": [
    37        {
    38          "when": { "params": { "lang": "cn" } },
    39          "returns": {
    40            "headers": { "Content-Type": "text/plain; charset=utf-8" },
    41            "body": "你好，世界！"
    42          }
    43        },
    44        {
    45          "returns": {
    46            "headers": { "Content-Type": "text/plain" },
    47            "body": "Hello, World!"
    48          }
    49        }
    50      ]
    51    }
    52  ]
    53  ```
    54  3. 以如下命令启动 MocKuma：
    55  ```
    56  $ mockuma
    57  ```
    58  4. 这样你就可以访问 [http://localhost:3214/](http://localhost:3214/) 或
    59  [http://localhost:3214/?lang=cn](http://localhost:3214/?lang=cn) 来查看结果。 
    60  
    61  #### 命令行参数
    62  虽然 MocKuma 可以直接执行，但是它也提供了一些命令行参数供配置使用，以下是所有支持的命令行参数：
    63  
    64  1. `-mapfile`: `MockuMappings` 映射配置文件路径，支持相对路径和绝对路径。
    65  默认情况下，将会依次寻找当前目录下名为 `mockuMappings.json`、`mockuMappings.main.json`、`main.json` 的配置文件并读取加载。
    66  特别的，MocKuma 的工作目录将会被设为该配置文件所在目录；
    67  2. `-p`: MocKuma 监听端口号，默认值为 `3214`；
    68  3. `--version`: 查看当前 MocKuma 的版本信息。
    69  
    70  #### 更多示例
    71  你可以点击[此处](example)来查看更多示例。