mxm-service-cli

服务接口自动化工具

• 更新内容

  支持Types, document 生成暂不支持。 更新使用文档

• 安装

    npm install -g mxm-service-cli

如果mac系统需要最高权限，需要加上sudo

   sudo npm install -g mxm-service-cli

---

• 执行

    mxmservice complie -d

命令	描述	options
complie	开始编译	-d 编译时到处文档

---

• 配置文件

在根目录（执行命令的位置）添加mxmservice.config.json

配置	描述	必填
version	接口版本，每次进行升级编译必须改变版本，否则不会进行完整编译	✓
folderName	定义服务模块文件夹名字，也是模块名字	✕ default:service
description	用于描述服务模块	✕
runEnvironment	运行环境	✓ dev | test | prod

//用例
{
  "version": "3.3.8",
  "folderName": "mxm_service_321",
  "description": "鲸图2.0的后端API",
  "runEnvironment":"dev",
  "outputPath": "src",
  "env": {
    "dev": {
      "url": "/mock",
      "timeout": "12000"
    },
    "test": {
      "url": "http://10.114.10.79:5000/api",
      "timeout": "12000"
    },
    "production": {
      "url": "/proxy",
      "timeout": "12000"
    }
  },
  "modules": [
     {
      "name": "DataSet",
      "prefix": "",
      "api": {
        "addDataSet": {
          "url": "/dataset/addDataSet",
          "method": "get",
          "useParams":true,
          "doc": {
            "method": "添加节点"
          },
          "request":{
            "name":"string!",
            "age":"number!",
            "nickname":"string"
          }
        },
        "dataSet": {
          "url": "/dataset/dataSet/:id",
          "method": "post"
        },
        "doshit": {
          "url": "/dataset/dataSet/:id",
          "method": "post"
        },
        "pigname": {
          "url": "/dataset/dataSet/:id",
          "method": "post"
        },
        "undksldataSet": {
          "url": "/dataset/dataSet/:id",
          "method": "post"
        },
        "dataGet": {
          "url": "/dataset/dataSet/:id",
          "method": "get"
        },
        "getDataSetList": {
          "url": "/dataset/dataset/getDataSetList",
          "method": "post"
        }
      }
    },
    {
      "name": "DataSource",
      "prefix": "",
      "api": {
        "dataSource": {
          "url": "/dataset/dataSource/:id",
          "method": "get"
        }
      }
    }
  ]
}

<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/all.js"></script> <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/v4-shims.js"></script>