• 可视化mockjs项目


    前言

    Mock就是用一个虚拟的对象(Mock 对象)来创建以便测试的测试方法。

    • 随着WEB技术的发展,前后端分离架构变得普遍起来,但是问题也随之而来,文档零散、不规范。并且经常碰到例如参数的新增、变动。这就导致了后端工程师需要耗费大量的时间维护接口文档
    • 前端的开发工作依赖于后端提供的接口数据,但是后端接口往往没有那么快就可以开发完成。这就导致了前端在“等”数据。
    • 上述的情况就会导致工作效率低下,沟通成本增加。接口管理平台的需求就日趋强烈
      所以这也促进了mock的出现和发展

    说说自己使用mock的变化

    1.原地模拟数据

    直接在页面data里面声明或者外部文件声明然后引入
    image.png

    image.png

    优点:这样相应页面就会有占位数据,有个直观的感觉

    缺点:数据写死,不会变化,也不是从接口获取 后期待对接的工作量还是很高,而且前期成本也不低

    2.接口声明return数据

    image.png
    这里其实和第一种没什么区别,在接口定义的地方返回数据。只是起到占位的作用,非要和第一个对比,只是增加了接口简单声明,为后面对接少了一点点工作量,其实后面对接,还是有很多工作要做。

    3.使用mock.js

    其实较早接触mock.js 最近才知道YApi
    直接模拟相应接口返回,接口名也可以自定义,数据类型也可以自定义 随意改动等等好处
    在下一步慢慢体会
    直接使用引入mockjs然后使用

    const ResultUtil = require('../_util/resultUtil');
    const Mock = require('mockjs');
    // 公告管理
    const dataList = Mock.mock({
      'rows|12': [
        {
          demoId: '@id',
          demoTitle: '@ctitle(3,10)',
          demoCnte: '<h2 style="text-align: center;">公告</h2><p>测试测试,内容内容。</p>',
          'demoMan|1': ['张三', '李四'],
          demoTime: '@datetime',
          'demoStatusText|1': ['生效', '未生效'],
          'demoStatus|1': ['1', '2'],
    
          'demoRole|1': ['1', '2'],
          'demoRoleText|1': ['专家', '社会监督员'],
          'demoMethod|1': ['1', '2'],
          'demoMethodText|1': ['PC', '微信'],
          demoFileList: [
            {
              archiveFor: 'xls',
              archiveId: 107,
              archiveName: '任务管理病案审核专家意见模板.xls',
              bizId: 'ZJYY0001',
              cldArchiveId: '557',
              crteTime: 1606443355672,
              crterId: '0',
              crterName: '超级管理员',
              fileBase64: null,
              matId: '1303',
              rid: '557',
              updtTime: 1606443355672,
              valiFlag: null,
            },
          ],
        },
      ],
    });
    // 操作历史
    const hisList = Mock.mock({
      'rows|32': [
        {
          hisId: '@id',
          hisResult: '@ctitle(3,40)',
          'hisName|1': ['张三', '李四'],
          hisTime: '@datetime',
          'hisTypeStatusText|1': ['生效', '未生效'],
          'hisTypeStatus|1': ['1', '2'],
          'opterRoleText|1': ['专家', '社会监督员'],
        },
      ],
    });
    
    module.exports = {
      // 查询列表
      'GET /demo/getList 500': ({ query }) => {
        const { pageNo = 1, pageSize = 10 } = query;
        const dataListItems = dataList.rows;
        const pageData = ResultUtil.pagination(pageNo, pageSize, dataListItems);
        return ResultUtil.pageSuccess(pageData, dataListItems.length);
      },
      // 查询详情
      'GET /demo/detail 500': ({ query }) => {
        const { demoId = '' } = query;
        const dataListItems = dataList.rows;
        const index = dataListItems.findIndex((item) => item.demoId === demoId);
        return ResultUtil.success(dataListItems[index !== -1 ? index : 0]);
      },
      //   查询历史记录
      'GET /demo/getHistory 500': ({ query }) => {
        const { pageNo = 1, pageSize = 10 } = query;
        const dataListItems = hisList.rows;
        const pageData = ResultUtil.pagination(pageNo, pageSize, dataListItems);
        return ResultUtil.pageSuccess(pageData, dataListItems.length);
      },
    };
    
    

    这样的话在项目中就可以像调用接口 然后去模拟随机生成数组,mockjs很强大 我也没全懂,具体详情官网奉上 mock官方文档项目地址

    这样的做法也是我之前的做法 我在使用的时候就在想 能不能更简单的去配置类似rap2或者easy-mock大搜车这样 可视化操作。
    如果你是团队多人 我也建议在这样的网站上拉个团队建个仓库 多人协调工作

    那我个人玩玩 接下来介绍本文重点-一个本地化的可视化配置的mock项目

    项目介绍

    一个基于mockjs、vue2、koa实现一个本地化的可视化配置的服务项目

    1.项目结构

    一个page是ui界面的项目
    一个server是本地接口服务项目

    image.png

    2.项目运行

    首先page和server都要安装依赖
    先把服务跑起来 然后再跑page

    // 命令1
    cd page
    yarn 
    yarn run serve
    // 命令2
    cd server
    yarn 
    yarn run serve
    
    

    image.png

    image.png

    3.项目使用

    这是跑起来的ui界面
    image.png
    你在这可以去添加各种模块和接口,然后自定义返回类型
    添加成功可以直接浏览器测试或者点测试接口 也可以在项目中使用
    注意点:如果你接口有参数之类是要相应填写的

    image.png

    image.png

    使用的话 知道操作后就特别的流畅方便 一开始上手可能需要摸清一下用法

    4.项目重点

    server的几个接口是重点 比如增加模块 增加接口删除接口等等 所以放出一些接口文档

    (1) 接口返回成功示例

    {
      success: true  // 主要通过这个字段去判断成功或者失败
      message: "新增成功"
      data: {list: [,…], total: 2}
      code: 200
    }
    

    (2) 接口返回失败示例

    {
      success: false
      data: null
      message: "child "url" fails because ["url" is required]"
      code: 400
    }
    
    1. 新增模块接口 post 方式 /section/createSection
    {
      "name": "模块1", // 模块名称-必填
      "pathName": "user", // 创建的文件夹名称以及调用接口需要加的前缀-必填且只能是英文(页面就叫接口前缀吧),每个模块的pathName唯一
      "description": "模块介绍" // 接口描述可选
    }
    
    1. 详情模块接口 post 方式 /section/getSectionDetail
    {
      "pathName": "user" // pathName-必填
    }
    
    1. 更新模块接口 post 方式 /section/updateSection
    {
      "id": 123, // id-必填
      "name": "模块1", // 模块名称-必填
      "pathName": "user", // 必填
      "description": "模块介绍" // 接口描述可选
    }
    
    1. 删除模块接口 post 方式 /section/deleteSection
    {
      "pathName": "user" // pathName-必填
    }
    
    1. 获取模块列表 post 方式 /section/getSectionList
    {
      "page": 1, // 当前页数可选
      "size": 2, // 每页显示条数可选
      "isPage": true // 必填,表示是否分页,true分页、false不分页
    }
    
    1. 新增接口 post 方式 /interface/createData
    // 提交参数
    {
      "pathName": "user", // 所属模块的模块pathName必填
      "name": "示例接口", // 接口名必填
      "url": "/createJson", // 接口地址必填
      "method": "GET", // 接口请求方式可选,默认"POST"
      "status": 200, // 状态码可选,默认200
      "description": "描述" // 接口描述可选
    }
    
    1. 详情接口 post 方式 /interface/getDetailData
    {
      "pathName": "user", // 所属模块的模块pathName必填
      "url": "/createJson" // 接口地址必填
    }
    
    1. 修改接口 post 方式 /interface/updateData (参数必填项还未全部确定)
    {
      "pathName": "user", // 所属模块的pathName必填
      "id": 123, // 所更改的接口id--必填
      "name": "示例接口", // 接口名--必填
      "url": "/createJson", // 接口地址--必填
      "method": "GET", // 接口请求方式--必填
      "status": 200, // 状态码--必填
      "description": "描述" // 接口描述
      // 自定义请求参数
      "request": [
          {
            "id": 100,
            "parentId": -1,
            "name": "name", // 字段名
            "required": true, // 是否为必填项
            "type": "String", // 字段类型
            "rule": "", // 生成规则
            "value": "", // 初始值
            "description": "数组属性示例" // 字段描述
          },
        ],
      // 自定义返回内容
        "response": [
          {
            "id": 6,
            "parentId": -1,
            "name": "数组", // 字段名
            "required": true, // 是否为必填项
            "type": "Array", // 字段类型
            "rule": "1-2", // 生成规则
            "value": "", // 初始值
            "description": "数组属性示例" // 字段描述
          },
          {
            "id": 11,
            "parentId": 6,
            "name": "子元素1", // 字段名
            "required": true, // 是否为必填项
            "type": "Array", // 字段类型
            "rule": "1-2", // 生成规则
            "value": "@cname", // 初始值
            "description": "数组一级子元素" // 字段描述
          },
        ]
    }
    
    1. 删除接口 post 方式 /interface/deleteData
    {
       "pathName": "user", // 所属模块的模块pathName必填
       "url": "/createJson" // 接口地址必填
    }
    
    10. 获取接口列表,带分页 post 方式 /interface/getDataList
    
    ```json
    {
       "pathName": "user",
      "page": 1, // 当前页数
      "size": 2, // 每页显示条数
      "isPage": true // 必填,表示是否分页,true分页、false不分页
    }
    

    小结

    不同平台的mock服务有不同的优缺点,当然如果我的文章对你有帮助 我也是很开心的
    image.png
    选最适合你的 或者 最容易上手的 反正就是结合你自己的需求去选择。这里推荐YApi。简单上手,尽量减少学习成本。Yapi这点比较好。简单的使用甚至不需要了解mock.js的api.直接配置即可。开源程度社区活跃度较高,且保持bug的修复与功能完善.

    参考链接

    1. mock官方文档项目地址
    2. yapi官方文档项目地址
    3. 常见MOCK-SERVER对比
    4. 几个mock平台的个人感受
    5. Mockito 简明教程

    PS:别问我为什么把好链接放后面(放前面 你们还能看完我的文章嘛) 要是觉得不错,点个赞哦

    结束语

    其实最近一直在练习 怎么取分享知识和写好文章。这两点我现在都做的不怎么好 也许是掌握不深 所以不知道怎样去表达知识点和分享精彩吸引人的内容。
    如果能坚持写博客 记录一下自己使用的技术之类 对我来说也是一种进步 孰能生巧!

    点关注不迷路!你那么帅(漂亮),都看到这了,动手点个赞鼓励一下作者,谢谢!

    点赞,点赞,点赞! 非常谢谢!

  • 相关阅读:
    2021年4月1日
    2021年3月31日
    2021年3月30日
    2021年3月29日
    2021年3月27日
    2021年3月26日
    2021年3月25日
    人件集阅读笔记03
    2020年3月24日
    构建之法阅读笔记02
  • 原文地址:https://www.cnblogs.com/wangxiaoer5200/p/14716752.html
Copyright © 2020-2023  润新知