yapi平台基本使用介绍

主界面介绍

image.png

分组管理菜单

1、项目列表

展示分组内自己所在的项目,点击进入项目详情

2、成员列表

展示和管理分组内的人员构成


image.png

1.添加成员
2.更改成员权限
3.删除成员

3、分组动态

展示分组内的项目接口动态


image.png

4、分组设置

image.png

自定义分组信息

项目

1、接口

1.1 接口列表

image.png

添加分类,生成新的接口集合
在分类中添加接口,新增简单接口信息

1.2 接口详情

1.2.1 预览

点击某个接口,进入接口详情--预览


image.png

展示详细的接口信息,包括基本信息,请求参数,返回数据等

1.2.2 编辑

点击顶部“编辑”,进入编辑模式

基本设置

接口的基本信息及路径
接口url中有参数的,可以用{}标识


image.png
请求参数设置

1.参数类型可以选择 body,query以及headers
2.body参数可以选择对应类型
3.选择form格式可以批量添加参数
4.选择json格式可以直接导入,系统会进行格式校验,通过后会自动解析并填充在下方


image.png
返回数据设置

1.返回数据为接口期望的返回结果,也可以已json格式或者raw格式填写
2.选择json格式可以直接导入,系统会进行格式校验,通过后会自动解析并填充在下方


image.png

1.2.3 运行

image.png

发送--请求此接口
保存--将此接口及请求数据保存至测试合集


image.png

1.2.4 高级mock

可以自定义接口返回,设置过滤条件,满足过滤条件时,请求的接口返回则为自定义的返回


image.png
image.png

此处设置一个期望,打开postman,请求对应的mock地址
参数满足过滤条件,则请求返回为自定义结果


image.png

1.3 测试合集

后续更新自动化实施详细讲解

2、动态

image.png

api更新修改后,此处可以查看修改记录及修改内容
点击改动详情,可查看接口的具体改动内容。红色表示删除的内容,绿色表示新增的内容。


image.png

3、数据管理--快速导入导出标准化接口

image.png

3.1-导入

点击弹出下拉框,可选择自己需要的模式
导入成功后,导入的接口会在接口列表中展示

3.2-导出

image.png

可将平台中已有的接口数据导出,导出后的文件可以作为数据源再次在其他项目导入。
可以解决项目迁移的问题

4、成员管理

对项目所属成员进行增加,删除,修改权限等操作

5、设置

image.png

5.1 项目配置

项目基本信息

5.2 环境配置

1、项目环境管理,可以配置多个不同的环境,在测试接口或者进行自动化测试时可以按需选择对应的环境
2、环境可以增加,可以删除
3、每个环境可以单独设置域名,请求头,全局变量等个性化数据,以满足测试的多样性


image.png

5.3 请求配置

可以自定义脚本,分为请求前和请求后的处理。请求前处理脚本,会在接口请求开始前执行,请求后处理脚本,会在请求完成后执行


image.png

5.4 token配置

生成唯一项目标识,可以作为请求yapi项目openapi的凭证
非可视化界面操作,yapi提供了部分常用的openapi。
如:进行自动化测试,定期进行接口同步,进行数据导入等等

5.5 全局mock脚本--未研究

5.6 生成ts services 未研究

5.7 swagger自动同步

可以选择时间,选择周期,选择同步方式,定期自动执行接口同步,保证yapi平台中接口为最新接口,不需要人工维护


6、wiki

无特殊功能,可以作为一个记事本,记录项目关联信息

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,313评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,369评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,916评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,333评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,425评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,481评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,491评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,268评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,719评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,004评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,179评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,832评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,510评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,153评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,402评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,045评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,071评论 2 352

推荐阅读更多精彩内容