search

YMFE / yapi

YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台
http://yapi.smart-xwork.cn/
Apache License 2.0
27.32k stars 4.78k forks source link

yapi 下个版本需求收集 #49

Open hellosean1025 opened 6 years ago

hellosean1025 commented 6 years ago

yapi 自开源两月以来，深得广大开发者的喜爱， 感谢大家的支持！

yapi 需要的是集思广益，把这个产品做成一个真正提高工作效率的软件。现收集下 yapi 下个版本的需求，大家有产品功能上的痛点都可以提出来。下面列表是目前收集到的需求：

Pengfei00 commented 6 years ago

支持 websocket 接口 文档？

hellosean1025 commented 6 years ago

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

shixuev5 commented 6 years ago

markdown

wengpengfeijava commented 6 years ago

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

hellosean1025 commented 6 years ago

@wengpengfeijava yapi

Pengfei00 commented 6 years ago

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

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

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

FoolRabbit commented 6 years ago

可以支持多级分类么

hellosean1025 commented 6 years ago

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

lichao0 commented 6 years ago

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

konamistan commented 6 years ago

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

zhangruican commented 6 years ago

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

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

xuzicn commented 6 years ago

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

WayneLiang commented 6 years ago

希望数据导出是可以排序

FoolRabbit commented 6 years ago

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

hellosean1025 commented 6 years ago

@FoolRabbit 文档写成注释吧 image

FoolRabbit commented 6 years ago

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

ardehaha commented 6 years ago

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

hellosean1025 commented 6 years ago

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

pastel001 commented 6 years ago

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

keepnode commented 6 years ago

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

image

hellosean1025 commented 6 years ago

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

yugasun commented 6 years ago

代码规范相关建议：

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

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

robertfun commented 6 years ago

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

keepnode commented 6 years ago

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

yugasun commented 6 years ago

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

hellosean1025 commented 6 years ago

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

hellosean1025 commented 6 years ago

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

llxiao commented 6 years ago

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

lichao0 commented 6 years ago

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

lichao0 commented 6 years ago

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

hellosean1025 commented 6 years ago

@lichao0 image

maxincai commented 6 years ago

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

newjia commented 6 years ago

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

tanshion commented 6 years ago

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

yuu2lee4 commented 6 years ago

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

llxiao commented 6 years ago

更新 通知 邮箱可以配置

dannyge commented 6 years ago

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

hellosean1025 commented 6 years ago

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

ardehaha commented 6 years ago

再补充3点：

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

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

PichurChill commented 6 years ago

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

liuyuan1989 commented 6 years ago

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

ALongLi commented 6 years ago

希望api-doc的数据支持

luluLouis commented 6 years ago

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

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

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

lazio10000 commented 6 years ago

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