SmartApi使用说明

缘起:

搞移动开发十多年了,接口、数据、数据模型、以及数据边界值的处理是需要团队协作解决,而这方面恰恰是总容易导致bug难修复的地方。而一款好用的api调试工具对于后端、前端、测试都是必须必的掌握熟练使用,Api就像人体的血管,里面有各种成分的数据,需要api工具进行可视化的解析分析然后给后端、前端、测试提供直观的结果反馈。市面上的诸多工具如最早的postman、eolink、以及近几年的postapi和foxapi等等都把使用场景复杂化,使用流程多元化。虽然能用但却不好用,每次打开一个都能导致电脑性能下降一大截。笔者实在是忍了很久,不想再忍了,于是自己自研了这款SmarApi开发工具软件单机版本。精炼、小巧、且功能完整。很适合开发和测试使用。归纳四大功能项进行如下说明

四大功能项

1、发起请求

在这里插入图片描述

1)接口名称

2)环境编辑和选择

3)URL完整展示

4)URL编辑和访问方式选择

5)请求参数编辑

2、请求响应

在这里插入图片描述

1)实时响应:
2)请求(request)
3)响应头
4)Cookie
5)成功示例
6)异常示例
7)响应码
8)响应时间
9)响应耗时
10)响应数据大小
11)响应网络地址
12)下载响应数据

3、PDF在线分享文档

在这里插入图片描述
保存接口后,点击分享文档即可看到分享文档面板
复制局域网分享地址即可查看PDF在线文档(建议协作方下载PDF文档备用
下面是一个在浏览器查看的在线PDF接口文档示例图:
在这里插入图片描述

4、本地化可编辑Mock数据解决方案-尤其是对于数据边界情况可调式

在这里插入图片描述
请求和响应是分析问题解析问题,那mock的功能就是能还原复现问题了,尤其是那些数据边界问题,比如int型和string类型混用字符串长度的边界对UI效果的影响空值情况产生的意外处理等等类似的数据和界面的冲突问题;如果是传统的方式那就是注入数据了,注入方式虽然也能解决问题,但做过的人都知道这样方式有点不够优雅,而且有时候出现污染问题等等。使用mock就没这样的问题了,直接修改响应的数据模型结构,数据值的大小,数据字段的类型等等。而且是通过本地http访问方式进行拉取数据的,方便、干净、整洁、快速等等优势。
SmartApi结合多年的实际开发经验,结合了mock.js开源库的特点。集成一起进行编辑,调试、使用为一体化。
1、只需要在编辑面板里填写mock数据模型语法,即可在右侧预览面板查看到示例数据效果,
2、建立本地mock服务只需要点击提交按钮即可。
3、然后复制后面的相对路径和url变量表达式,粘贴到url编辑框里,在选择mock环境,即可在URL预览里查看到完整的URL路径,点击发送即可获取到相应数据。如想验证也容易,在浏览器里里粘贴完整url路径即可访问到对应的数据
在这里插入图片描述
结果如下:
在这里插入图片描述

下面是几个mock的小例子:
列表

{
    "list|10": [
        {
            "price": "@float(0, 100, 2, 4)",
            "isRead": "@boolean",
            "ctitle": "@ctitle",
            "csentence": "@csentence",
            "title": "@title",
            "content": "@sentence",
            "author": "@cname",
            "author2": "@name",
            "img": "@image",
            "lookCount": "@integer(0,10000)"
        }
    ]
}

标题

{
    "title1": "@title(2,4)",
    "ctitle2": "@ctitle(3,5)"
}

等等。就不一一展示了
后面还有一个“…”的,可以查看mock更加具体的使用说明
在这里插入图片描述
在这里插入图片描述

下载地址:

 
posted @ 2023-09-17 11:49  lichong951  阅读(18)  评论(0编辑  收藏  举报  来源