yapi
yapi copied to clipboard
yapi 下个版本需求收集
yapi 自开源两月以来,深得广大开发者的喜爱, 感谢大家的支持!
yapi 需要的是集思广益,把这个产品做成一个真正提高工作效率的软件。现收集下 yapi 下个版本的需求,大家有产品功能上的痛点都可以提出来。下面列表是目前收集到的需求:
- yapi 默认集成 ldap 登录方式
- yapi 做一个 sso 登录插件,基于现有的 qsso 改造成大多数公司可用的
- 接口运行参数值支持 函数表达式,支持可视化选择 mock 参数和 变量参数
- 接口运行支持加工运行前后的 request 和 response ,主要是处理加密的接口或各种 token 参数问题
- 接口集可支持服务端代理,配合 jenkins 实现契约型测试
- 以项目为维度的自动化代码生成功能,默认提供一些 js,java, php 等语言相关框架的模板,可高度自定义生成模板
- 支持 dubble 等 rpc 接口定义
- 支持对 response header 定义
- 增加接口改动历史功能
- 版本管理(实现方式还未想好)
- 接口文档按分类组织接口
- 接口文档备注支持 markdown
- 环境设置支持全局 header 和 自定义变量
- 测试集复制功能
- 接口菜单和测试集菜单可调整顺序
支持 websocket 接口 文档?
@wnstar 接口文档多人协作编辑,类似 google doc?
markdown
好东西! 不知道你们怎么叫这个产品的? 丫皮还是Y api
@wengpengfeijava yapi
@suxiaoxin 多人协作感觉对于文档没必要 我指的是现在没办法添加 websocke的接口文档 也没办法测试websocket 看有没有必要添加上这个功能
- 接口项和分类排序(有些后面加的接口想排到前面去,现在没办法排,有些难受)
- 环境现在只能设置一个地址,希望对环境引入一些自定义变量(kv对)的设置,然后项目的querystring以及其他填写参数的地方可以用上这个变量(postman有类似的东西,希望 yapi 也可以有😄)
二次开发和插件机制未来应该是重点,每个公司都有个性化需求
可以支持多级分类么
@FoolRabbit 不支持,建议扁平化成一级分类 a- xxx b- yyy
可以支持导出、导入json格式吗,方便数据迁移
1.传参改为支持number类型,浮点和整数 2.自定义请求 比如curl --url --header ('sign':md5(body+timestrap+privateKey),'time':timestrap) --body ('time':'奇数取前1位偶数取后10位,且与header timestrap保持一致' )
接口request body application/json的 也要支持 参数的表达式。
---------------补充 错了。看了源码发现支持现有的表达式的。 { code: "{{ $.1.body.code }}" }
搜索接口希望不仅搜索名称,还需要搜索路径和备注
希望数据导出是可以排序
response字段说明,字段类型,长度定义等等
@FoolRabbit
文档写成注释吧
@suxiaoxin 好的,另外相同的路径接口无法添加,我们有些接口通过参数区分的。
建议接口Response增加针对不同http status的样例。例如200,400等。具体可以参考一下raml的结构 https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#responses
@FoolRabbit 支持通过 query 区分不同 path 的接口 /api/path?c=a /api/path?c=b
希望高级mock,mock期望的response body里面支持mockjs 就像定义接口的response body一样,这样使用起来更方便,而且对使用者来说,都是定义response body 有的地方支持,有的地方不支持,容易照成疑惑,使用户迷惑,影响用户体验
希望能在运行测试界面,增加参数备注(就是把编辑的时候,参数的备注列出来),这样子测试填写测试数据时,根据备注,更方便的填写测试数据
@keepnode 开两个浏览器窗口实现吧
代码规范相关建议:
- 建议客户端代码和服务端代码严格遵守
eslint配置
校验,现在没有相关校验脚本,我本地尝试eslint client/ server/ --quiet
会有很多错误,添加pre-commit
来进行eslint
校验。 - 添加
.editorconfig
文件。
@suxiaoxin 这。。。让我无言以对。。。
需要装chrome插件感觉不太友好,是否可以让服务端去和api接口交互返回测试结果,非常棒的项目,希望越来越好
希望增加接口修改历史记录查看功能,当某段时间,多人修改同一接口时,可以查看谁修改的。修改的信息是那些
建议添加项目粒度的接口备份功能。 业务场景是这样的:点击导出项目接口数据,然后可以再次导入该项目接口数据,实现备份还原。
@keepnode v1.3.0 版本已经支持修改历史记录查看功能
@robertfun 服务器代理不支持内网