yapi 下个版本需求收集

[ymfe]

yapi 下个版本需求收集

[FoolRabbit]

可以支持多级分类么

[wengpengfeijava]

好东西! 不知道你们怎么叫这个产品的？ 丫皮还是Y api

[Pengfei00]

支持 websocket 接口 文档？

[xuzicn]

搜索接口希望不仅搜索名称，还需要搜索路径和备注

[pastel001]

希望高级mock，mock期望的response body里面支持mockjs
就像定义接口的response body一样，这样使用起来更方便，而且对使用者来说，都是定义response body
有的地方支持，有的地方不支持，容易照成疑惑，使用户迷惑，影响用户体验

[robertfun]

需要装chrome插件感觉不太友好，是否可以让服务端去和api接口交互返回测试结果，非常棒的项目，希望越来越好

[shixuev5]

markdown

[Pengfei00]

@suxiaoxin 多人协作感觉对于文档没必要 我指的是现在没办法添加 websocke的接口文档 也没办法测试websocket 看有没有必要添加上这个功能

[lichao0]

可以支持导出、导入json格式吗，方便数据迁移

[konamistan]

1.传参改为支持number类型，浮点和整数
2.自定义请求
比如curl --url --header ('sign':md5(body+timestrap+privateKey),'time':timestrap) --body ('time':'奇数取前1位偶数取后10位，且与header timestrap保持一致' )

[FoolRabbit]

@suxiaoxin 好的，另外相同的路径接口无法添加，我们有些接口通过参数区分的。

[ardehaha]

建议接口Response增加针对不同http status的样例。例如200，400等。具体可以参考一下raml的结构
https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#responses

[gaoac]

能否支持自定义json对象，将其作为变量重复利用

[hellosean1025]

@keepnode 开两个浏览器窗口实现吧

[maxincai]

希望增加关联 Swagger URL 和 同步 Swagger 功能。
可参考 https://www.easy-mock.com/docs#chuang-jian-yi-ge-xiang-mu

[ardehaha]

再补充3点：

1. 测试集合的分类：目前我们公司使用测试集合去重现一些用户使用场景，一个系统支持的用户场景可能上百个，因此如果对测试集合本身能有地方可进行业务方面的描述和分类，会更便于回归测试的管理
2. 测试集合的批量执行及执行报告：可选定特定的测试集合进行回归测试，并对测试结果进行一个整体结果的记录，也可查询测试集合的历史执行结果（主要针对CI部分的集成考虑）
3. 对项目测试集合执行结果的状态图标：类似https://g.codefresh.io/api/badges/build

[JerryChaox]

一个请求多个response支持
项目全局response支持，比如参数错误
swagger多个response支持，目前导入只有一个response

[zlab]

二次开发和插件机制未来应该是重点，每个公司都有个性化需求

[hellosean1025]

@lichao0

[liuyuan1989]

希望增加三项提高研发测试效率功能
1.增加命令行工具 扫描mongodb 接口定义数据生成指定语言的代码块和注释
2.增加命令行工具 扫描指定的文件 若接口方法注释有变更则更新mongodb源 保证代码注释与接口文档同步
3.增加json-schema验证功能 对接口返回的数据格式进行校验

[lazio10000]

希望增加在线更新swagger文档更新。导入的swagger文档增加出入参的描述信息。

[southsala]

如图,希望能多加几个列表接口单页显示数量的选项，10个有点太少了，例如加10,30,50的选项，项目里现在将近400条接口。

还发现一个问题，在第一个子类里选中分页第二页，这时点击第二个子类后，显示的是第二子类第二页而不是第一页。

[laomu1988]

希望导出的数据还可以导入， 例如我一个项目的文档，想迁移到另一个项目或者环境中，现在只能从数据库中拷贝数据

[jszjgqq]

我这边的项目都是跟着系统走的，具体的来说比如我有A,B,C,D,E,F,G这么多个系统，然后每一个项目可能会涉及到不同的系统，

比如
PROJECT1项目用到A,B,C系统
PROJECT2项目用到A,E,D,F系统

如果按照项目创建，那么会重复写A系统的接口，那有没有办法只维护一个接口呢？

刚刚看了下YAPI，好像测试集合里面无法关联不同项目下的接口，如果能关联，那么这个问题也就解决了（主要前端不知道项目中的某个功能模块调用哪个系统下的接口，所以我想通过测试用例来展现，但是发现测试集合并不能跨项目的导入接口。）

[hdpter]

是否可以增加接口文档的PDF导出功能，便于分享给合作伙伴

[chrisfoon]

用了一段时间， 有两个极其不方便的地方，有时候用到绝望。希望能支持到：

1. 定义 request 和 response 的 object , 可以被多个接口重复引用，而不用到处复制黏贴，变更也不用到处修改所有的接口。

2. 枚举列表支持添加备注说明，否则这个功能意义大大降低。（这个字段枚举：0，1，2 ，他分别代码的语义现在只能在备注里去加，新增状态两边跑着去改，如果有新增，编辑，查询等接口因为没有上一条的定义对象的功能，也需要改一遍）

[branchzero]

1. 接口项和分类排序（有些后面加的接口想排到前面去，现在没办法排，有些难受）
2. 环境现在只能设置一个地址，希望对环境引入一些自定义变量(kv对)的设置，然后项目的querystring以及其他填写参数的地方可以用上这个变量（postman有类似的东西，希望 yapi 也可以有😄）

[zhangruican]

接口request body application/json的 也要支持 参数的表达式。

---------------补充
错了。看了源码发现支持现有的表达式的。
{
code: "{{ $.1.body.code }}"
}

[llxiao]

@branchzero 左侧菜单栏可以支持单独滚动条，接口文档过多时 操作困难

[dannyge]

可以考虑支持从阿里的 RAP 自动迁移么？

[taotao2014]

首先为yapi点个大大的赞，其次希望开放api接口，以方便和自己内部的系统做集成，如：测试集合能否开放出来api http接口？一般情况下在jenkins编译生成打完包部署后，触发这个进行接口测试.......

[ALongLi]

希望api-doc的数据支持

[git-patrickliu]

希望增加扩展Mockjs的占位符的入口。这样的话，新增接口就可以更加规范。

[newliver]

希望加入：

1. 接口优先级(可排序)
2. 接口多版本号支持

[zhy4013]

希望增加多语言支持

[zl939144892]

可否支持一下多级分类?

[hellosean1025]

@Wnstar 接口文档多人协作编辑，类似 google doc?

[hellosean1025]

@wengpengfeijava yapi

[hellosean1025]

@FoolRabbit 不支持，建议扁平化成一级分类
a- xxx
b- yyy

[WayneLiang]

希望数据导出是可以排序

[FoolRabbit]

response字段说明，字段类型，长度定义等等

[hellosean1025]

@FoolRabbit
文档写成注释吧

[hellosean1025]

@FoolRabbit 支持通过 query 区分不同 path 的接口
/api/path?c=a
/api/path?c=b

[keepnode]

希望能在运行测试界面，增加参数备注（就是把编辑的时候，参数的备注列出来），这样子测试填写测试数据时，根据备注，更方便的填写测试数据

[yugasun]

代码规范相关建议：

1. 建议客户端代码和服务端代码严格遵守 eslint配置 校验，现在没有相关校验脚本，我本地尝试 eslint client/ server/ --quiet 会有很多错误，添加 pre-commit 来进行 eslint 校验。
2. 添加 .editorconfig 文件。

[keepnode]

@suxiaoxin 这。。。让我无言以对。。。

[keepnode]

希望增加接口修改历史记录查看功能，当某段时间，多人修改同一接口时，可以查看谁修改的。修改的信息是那些

[yugasun]

建议添加项目粒度的接口备份功能。
业务场景是这样的：点击导出项目接口数据，然后可以再次导入该项目接口数据，实现备份还原。

[hellosean1025]

@keepnode v1.3.0 版本已经支持修改历史记录查看功能

[hellosean1025]

@robertfun 服务器代理不支持内网

[lichao0]

接口内容更新后，是否可以通过发站内提醒或发邮件的形式通知相关成员查阅

[lichao0]

是否可以考虑增加查看接口的历史版本功能，动态页面只能看到是谁更新的接口，并不能知道更新了什么内容

[newjia]

请抽点精力做一下 Request 设置 - body - form 格式的多种类型支持，如浮点，整形，OBJECT类型等
我们某个项目是用PHP 做的，暂不支持JSON 类型的，只支持FORM。请考虑一下。
如能采纳，非常感谢！

[tanshion]

左边接口列表栏的宽度和右边内容栏的宽度，可以拖动调整宽度。

[yuu2lee4]

支持openapi3 即swagger3的导入 现在导入response这块儿有问题

[llxiao]

更新 通知 邮箱可以配置

[hellosean1025]

@dannyge 可以参考下postman 数据导入插件
https://github.com/YMFE/yapi/tree/master/exts/yapi-plugin-import-postman
开发一个可以导入 rap 数据的

[PichurChill]

希望管理员有个接口“回收站”功能，保存30天内删除的类似。
曾经一个眼疾手快 删除->确定 把接口给删了 = =。。

[luluLouis]

希望高级Mock中的response增加注释，一部分结构保留，其他结构可从接口的response中同步过来，解决设置高级Mock后修改接口字段无法同步到高级Mock的问题

[laomu1988]

1. 希望测试集合中左侧列表展示的是调整后的顺序（v1.3.6已实现）
2. 希望测试case增加复制功能（ 一个api可能对一个多个场景）
3. 测试报告中增加测试失败的错误信息
4. 希望测试集合中的“动态变量”在单独测试时能够直接使用上次测试结果中的值，方便调试测试case
5. 希望测试变量中能增加自定义常量和自定义变量，在测试时多个case可能复用相同数据
6. 希望Test 脚本中也可以使用类似“$.269.params”的“动态变量”，且console.log语句可在浏览器端输出，便于调试

[Hello-Mango]

YAPI通过swagger导入是否可以支持根据tags进行分类？

[hellosean1025]

@Hello-Mango 支持，会自动根据 tag 创建分类的

[Hello-Mango]

@suxiaoxin 你好，我这边本地部署，使用swagger导入的时候，必须要选择默认分类，如果选择了默认分类，导入之后的数据就全部都在该分类下，如下图

是否我的使用方法不对？版本是1.3.6 望回复，感谢

[nefeed]

希望下个版本的接口变更的邮件通知不要只是分类id，而是能够带上分类名称的变动

[hellosean1025]

@Hello-Mango 可以上传一份数据，我们这边调试下

[yili1992]

发现断言只有在 测试集里才有，请问有没有计划开发导入测试集数据？

[Hello-Mango]

swagger.txt
@suxiaoxin 你好 数据已经上传，由于github不支持json数据上传，后缀我修改成了txt，感谢

[yili1992]

希望能够增加 测试集 测试用例可以从其他项目引入，或者 项目数据导出，可以导出接口json数据，然后其他项目导入json数据

[hellosean1025]

@Hello-Mango 已经修复了，关注下个版本吧

[hellosean1025]

[Hello-Mango]

@suxiaoxin 感谢

[jiangchao0304]

首先非常感谢开源出这样的产品。 目前一直在找一款这样的产品，市面上很多在线的基于种种原因，不能上公网或者放网上怕数据丢失或者泄露等，老牌的swagger优势劣势不说了，部署过rap。。说实话团队背景确实大，但这个产品真心就是做着玩的。。不说了，直到遇到yapi 各种操作小清新，顺手，。 目前最大的困惑就在一点 ,
希望能实现 用json格式，但是显示格式为表格，这样其他开发人员拿到文档可以一目了然的知道当前json的结构每个字段的含义，备注，类型，最终mock的时候还是为json序列化后发送。目前文档上显示为json格式感觉没什么意思，看不出来字段的说明，或者显示效果能做一个切换按钮，表格格式或者json,

[hellosean1025]

@jiangchao0304 目前 json 的可视化编辑器已经开发完成，关注下个版本的发布吧，提前给你截个图：

[tanshion]

希望加一个全部接口的目录索引页面

[ansonhorse]

个人比较期望的是导出导入功能，最好可以指定分组或者项目

[jiwenfei]

建议支持 集成swagger的后台代码生成功能

[laomu1988]

能否支持导出某一个分类下的接口

[liuyu1992]

想知道支持 dubble 等 rpc 接口定义啥时候可以实现

[dicklwm]

感谢yapi带来这么好的产品，以下是我的体验优化建议：

1. 接口高级Mock -> 期望，希望增加启用不启用
2. 接口运行 -> POST -> request body，JSON格式下，不能使用函数方法
3. 数据导入支持APIBluePrint
4. 测试集合 -> Test -> 右边的快捷按钮，可能不是每个开发者都使用body.errcode这样的返回码，建议换成assert的一些常用方法和系统提供的一些参数变量$.{key}.{params|body}.{path}
5. 测试集合 -> 导入接口 -> 状态，状态栏可以最个排序或筛选
6. 接口高级Mock -> 期望 -> 添加期望，body不应该被滚动，已提PR

[southsala]

首先感谢YAPI
其次希望测试集合功能可以添加描述功能，我们这边现在用测试集合向移动端描述某个场景需要使用哪些接口，没有描述的话还是有些不便
测试集合简介的话只有编辑才能查看到

Version 1.3.8

[hdpter]

是否可以增加错误码和错误描述设置界面

[FurionCS]

是否可以支持单个接口 pre-request script

[agxmaster]

1.提供一个配置测试用例数据case的功能，yapi来代替单元测试，一个接口要测试很多case
2.支持导入swagger文档地址，swagger变化能自动更新
3.支持夸项目的集合测试，我理解的yapi是可以做微服务的集成测试的，比如购物车服务可以能会依赖商品，活动，库存，客资等服务，传统的单元测试是很难解决跨服务的测试问题的这也是yapi的优势
4.无限极集合测试，小的功能组成大的功能就是这样

[fudali113]

是否可以添加一个注册用户审核和注册邮箱限制的相关功能?

[chemphern]

1.接口多版本号支持
2.项目里可以有项目信息详情显示页，展示项目基本信息，项目备注，项目描述说明等。
3.form表单结构，但是单个请求参数是json字符串的情况，需要分级解释下json的格式
4.模拟发送请求，即运行那里，能否支持直接copy一个json，自动转化为参数，或者复制一个key:value，换行的数据，自动转化为参数进行发送

[xieyingbiao]

支持grpc导入
支持yapi的web提供升级按钮，不需要再到服务端升级

[xiaodongning]

未来有可能支持导出的json数据可以导入postman吗？

[wangxin8899]

来自一个测试的需求：
类似jmeter的参数化管理功能，每个插件都可以用${变量名}引入，区别yapi的请求配置（context.reponse.body.变量名）每个接口的参数都不太一样，不好一锅端引入呀。如果接口量大了，需要统一管理一些全局变量。比如用户名、密码、产品id等。

望采纳!

ps:小弟在学react了,引入公司投产后，希望能定制化维护起来。

[xiaodongning]

能否body处增加类似postman的功能 如图：

[SmileTower]

官网 怎么没有忘记密码

[JerryChaox]

接口自动更新可以借助版本管理工具的，webhook，代码push、merge时自动更新，不过目前应该只有swagger能做到，也是不错了。

[yeah2]

希望增加hmac hash算法

[caiboking]

YAPI 在接口前后端接口约定到时候，有些情况需要讨论，所以希望能支持接口的讨论功能。

比如后端设计接口后，前端看觉得有问题或建议，这时候如果能直接添加类似issue这样讨论的功能就好了，不用再通过其他方式交流。

[hejunrex]

1.上面一位说的建议增加一个公共引用的功能，比如枚举说明定义在一个地方，查看的时候跳到引用的地方就好，不然需要改很多个地方，现在这个就没有wiki方便
2.右侧滚动条建议恢复正常宽的模式，现在超级窄，在不用鼠标的时候基本点不到拖动，太痛苦了【强烈建议】
3.接口预览页面建议垂直间距调小一点，开始除几个有用的信息其他都是无用信息，占据打开的整屏，接口定义数据需要不断来回滚动鼠标才能查看到，由于内容不够聚集，滚动次数比较多一天下来手还是有点酸的，太影响使用体验
4.建议完善权限功能，最好可以具体到功能点，同时页面上如果没有权限的可以灰色表示，现在的角色里没有测试，如果都分配开发角色出现了接口删除又没办法恢复
5.备注信息支持换行，现在写的都在一行，看起来很麻烦
6.参数区折叠默认展开，因为API就是为了看参数，每次都需要去一个个点开太麻烦了
7.参数表格建议优化下格式，或者设置一些固定长度，当前如果备注写的内容较多的话，表格完全变形无法看

[gandao]

@hejunrex
您好！仔细看了一下您提出的需求
第一个需求我们会在版本19中发布
第二个需求，平时滑动网页不是通过鼠标滚轮或者mac的触摸板嘛？
第三、四个需求我们还在努力中
第五个需求，我试了一下可以换行啊！可以看下面图片

第六个需求，我们需要收集一下其他使用者的意见，再决定
第七个需求，我简单的测试了一下没有发现问题，能否截个图给我看一下问题所在

[hejunrex]

@gandao
这个是我编辑带换行的

这个是实际显示的，没有换行，而且表格最小宽度没有

看了下代码是因为使用的xxx.css.gz里面的css文件缺样式，外围的xxx.css是有的，文件不统一造成的

[gaoxiaomumu]

@hejunrex 这json schema备注换行问题下个版本会解决,， 我们以为是接口备注换行呢

[Kemper-Diao]

#返回参数是否支持多类型配置,比如：一个地址的时候用string ，当有多个地址的时候用array

[gaoxiaomumu]

如果是前端mock需要这种多类型返回值的话，可以去高级mock里面进行设置，如果只是展示用的话可以将这种结构信息写在备注里面

[zl939144892]

还有, 如果可以设置一些返回值的公共对象就好了, 比如登录, 注册和获取个人信息的接口都会返回同样格式的数据