Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

期待需求 #1

Open
qbb-dev opened this issue May 20, 2019 · 72 comments
Open

期待需求 #1

qbb-dev opened this issue May 20, 2019 · 72 comments

Comments

@qbb-dev
Copy link
Contributor

qbb-dev commented May 20, 2019

如果觉得目前插件有任何需要改进的地方或者未满足的需求 请在这里留言

@qbb-dev qbb-dev pinned this issue May 20, 2019
@qbb-dev
Copy link
Contributor Author

qbb-dev commented May 21, 2019

1:支持 xxxMapping value 为空情况 [已支持]
2:支持 RequestParam 备注从注释中获取 [已支持]
3:支持 notnull 分组
4:支持其他校验参数注解 比如NotBlank

@smileyao
Copy link

smileyao commented May 24, 2019

参数String注解NotBlank时,希望能识别为必填

@qbb-dev
Copy link
Contributor Author

qbb-dev commented May 24, 2019

参数String注解NotBlank时,希望能识别为必填

下个版本1.6.8支持

@xiaoyuervae
Copy link

新版本的idea 是不是不支持啊 一直显示please check config,[projectToken,projectId,yapiUrl,projectType]

@qbb-dev
Copy link
Contributor Author

qbb-dev commented May 28, 2019

新版本的idea 是不是不支持啊 一直显示please check config,[projectToken,projectId,yapiUrl,projectType]

请提供下版本,和当前的配置

@qbb-dev
Copy link
Contributor Author

qbb-dev commented May 28, 2019

参数String注解NotBlank时,希望能识别为必填

下个版本1.6.8支持

推迟一个版本支持

@swuzjb
Copy link

swuzjb commented Jun 6, 2019

期待一个 当接口已存在不更新的配置项,以免一些修改被覆盖。

@JackyLeeCS
Copy link

期望支持kotlin

@JackyLeeCS
Copy link

期望支持kotlin

现在会报异常

java.lang.NullPointerException
	at com.qbb.build.BuildJsonForYapi.actionPerformedList(BuildJsonForYapi.java:80)
	at com.qbb.interaction.UploadToYapi.actionPerformed(UploadToYapi.java:118)
	at com.intellij.openapi.actionSystem.ex.ActionUtil$1.run(ActionUtil.java:261)
	at com.intellij.openapi.actionSystem.ex.ActionUtil.performActionDumbAware(ActionUtil.java:278)
	at com.intellij.openapi.actionSystem.impl.ActionMenuItem$ActionTransmitter.lambda$actionPerformed$0(ActionMenuItem.java:292)
	at com.intellij.openapi.wm.impl.FocusManagerImpl.runOnOwnContext(FocusManagerImpl.java:283)
	at com.intellij.openapi.wm.impl.IdeFocusManagerImpl.runOnOwnContext(IdeFocusManagerImpl.java:107)
	at com.intellij.openapi.actionSystem.impl.ActionMenuItem$ActionTransmitter.actionPerformed(ActionMenuItem.java:282)
	at javax.swing.AbstractButton.fireActionPerformed(AbstractButton.java:2022)
	at com.intellij.openapi.actionSystem.impl.ActionMenuItem.lambda$fireActionPerformed$0(ActionMenuItem.java:111)
	at com.intellij.openapi.application.TransactionGuardImpl.runSyncTransaction(TransactionGuardImpl.java:88)
	at com.intellij.openapi.application.TransactionGuardImpl.lambda$submitTransaction$1(TransactionGuardImpl.java:111)
	at com.intellij.openapi.application.TransactionGuardImpl.submitTransaction(TransactionGuardImpl.java:120)
	at com.intellij.openapi.application.TransactionGuard.submitTransaction(TransactionGuard.java:121)
	at com.intellij.openapi.actionSystem.impl.ActionMenuItem.fireActionPerformed(ActionMenuItem.java:111)
	at com.intellij.ui.plaf.beg.BegMenuItemUI.doClick(BegMenuItemUI.java:524)
	at com.intellij.ui.plaf.beg.BegMenuItemUI.access$300(BegMenuItemUI.java:35)
	at com.intellij.ui.plaf.beg.BegMenuItemUI$MyMouseInputHandler.mouseReleased(BegMenuItemUI.java:546)
	at java.awt.Component.processMouseEvent(Component.java:6550)
	at javax.swing.JComponent.processMouseEvent(JComponent.java:3325)
	at java.awt.Component.processEvent(Component.java:6315)
	at java.awt.Container.processEvent(Container.java:2239)
	at java.awt.Component.dispatchEventImpl(Component.java:4899)
	at java.awt.Container.dispatchEventImpl(Container.java:2297)
	at java.awt.Component.dispatchEvent(Component.java:4721)
	at java.awt.LightweightDispatcher.retargetMouseEvent(Container.java:4904)
	at java.awt.LightweightDispatcher.processMouseEvent(Container.java:4535)
	at java.awt.LightweightDispatcher.dispatchEvent(Container.java:4476)
	at java.awt.Container.dispatchEventImpl(Container.java:2283)
	at java.awt.Window.dispatchEventImpl(Window.java:2746)
	at java.awt.Component.dispatchEvent(Component.java:4721)
	at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:766)
	at java.awt.EventQueue.access$500(EventQueue.java:98)
	at java.awt.EventQueue$3.run(EventQueue.java:715)
	at java.awt.EventQueue$3.run(EventQueue.java:709)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:84)
	at java.awt.EventQueue$4.run(EventQueue.java:739)
	at java.awt.EventQueue$4.run(EventQueue.java:737)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.awt.EventQueue.dispatchEvent(EventQueue.java:736)
	at com.intellij.ide.IdeEventQueue.defaultDispatchEvent(IdeEventQueue.java:729)
	at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:674)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:373)
	at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:205)
	at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
	at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
	at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)

@820229268
Copy link

期待对 get请求 参数是一个实体Bean的支持

@swuzjb
Copy link

swuzjb commented Jun 14, 2019

目前插架对Integer 包装类上传后的类型 也为 Integer 但是 yapi的定义是 integer 需要特殊处理下

@xujiamingpython
Copy link

3:支持notnull分组 现在支持了吗?

@Sparkinzy
Copy link

期望支持php , 注解格式如果能自定义的话,最好不过了!目前使用的是apidoc 的格式做的接口文档

@leeyongyao
Copy link

希望支持父类controller中的接口

@Planeswalker23
Copy link

希望在接口中加一个与@menu类型的注解,如@status,标志接口的完成状态。现在默认都是done。

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jul 30, 2019

希望在接口中加一个与@menu类型的注解,如@status,标志接口的完成状态。现在默认都是done。

可行,下个版本支持

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jul 30, 2019

apidoc

很抱歉,php 不了解,如果需要请二次开发

@w420372197
Copy link

能否吧配置写到其他文件中, misc.xml 文件属于配置文件,不好提交

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jul 31, 2019

能否吧配置写到其他文件中, misc.xml 文件属于配置文件,不好提交

为了就是不能提交,每个人的配置不一样,token 不一样

@lms-8023
Copy link

lms-8023 commented Aug 6, 2019

目前@menu加载类上的话不生效,因为在方法上没有单独设置@menu且方法优先级大于类,导致生成的Yapi文件夹为默认名称tool-temp。其次关于返回值使用@return并没有在Yapi中生成内容

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Aug 6, 2019

为在方法上没有单独设置@menu且方法优先级大于类,导致生成的Yapi文件夹为默认名称tool-temp。

请提供下版本和注释,正常结果是类上有@menu,方法没有回使用类上的,第二个问题,返回结果不是通过@return 决定的,是通过方法实际写的返回值决定

@lms-8023
Copy link

lms-8023 commented Aug 7, 2019 via email

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Aug 7, 2019

public SuccessMsg(Object data) { this.success = true; this.message = "成功"; this.data = data; }

我使用插件版本1.7.1 尝试复现您的@men问题,很抱歉没有复现,能正常创建菜单,并且接口归属于Test 下,关于第二个问题您贴的图似乎有问题。如果可以请加qq群644642474 ,然后@ernest,会给你解答

@lms-8023
Copy link

lms-8023 commented Aug 7, 2019 via email

@csman7117
Copy link

notblank注解 还是没起作用,notnull分组 没起作用
插件版本: 1.7.2
bean注释:

@NotNull(groups = {UpdateGroup.class}, message = "主键不能为空")
private String id;


@NotBlank(groups = {AddGroup.class}, message = "运营服务公司全称为空")
private String companyName;

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Aug 12, 2019

notblank注解 还是没起作用,notnull分组 没起作用
插件版本: 1.7.2
bean注释:

@NotNull(groups = {UpdateGroup.class}, message = "主键不能为空")
private String id;


@NotBlank(groups = {AddGroup.class}, message = "运营服务公司全称为空")
private String companyName;

暂时还没支持

@scofier
Copy link

scofier commented Aug 19, 2019

希望支持枚举类型的识别

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Aug 21, 2019

希望支持枚举类型的识别

请具体说明

@scofier
Copy link

scofier commented Aug 27, 2019

希望支持枚举类型的识别

请具体说明

类似下面定义的枚举, 现在是需要在注释里面把枚举值MAIL、FEMAIL都写在注释里面,希望能自动识别,比如: MAIL: 男性,FEMAIL: 女性。

/**
 * 性别 枚举
 */
public enum SexEnum {
    /**
     * 男性
     */
    MALE(0),
    /**
     * 女性
     */
    FEMALE(1);

    Integer value;

@VangelisHaha
Copy link

非常感谢有这样的工具让我司更加快速的创建接口,这真的非常棒。但是我司有一些自动化接口的需求,希望我们在接口文档中备注出去添加请求json示例返回json示例
image
可否支持针对于图上备注信息的定制呢?非常感谢作者的开源。

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jan 7, 2020

非常感谢有这样的工具让我司更加快速的创建接口,这真的非常棒。但是我司有一些自动化接口的需求,希望我们在接口文档中备注出去添加请求json示例返回json示例
image
可否支持针对于图上备注信息的定制呢?非常感谢作者的开源。
很抱歉,图裂了,可以重新上传试试吗?或者可以加群qq644642474 @ernest

@VangelisHaha
Copy link

非常感谢有这样的工具让我司更加快速的创建接口,这真的非常棒。但是我司有一些自动化接口的需求,我们希望在接口文档中备注出去添加请求json示例状语从句:
可否请立即获取iTunes针对于图产品上备注信息的定制呢?非常感谢作者的开源。
很抱歉,图裂了,可以重新上传试试吗?或者可以加群qq644642474 @ernest返回json示例
图片

期望结果:
image-20200108192903222

图中备注处可以通过一定方式支持定制,而不是默认方法的代码
image-20200108193159595

@VangelisHaha
Copy link

image-20200108193159595

@VangelisHaha
Copy link

现状
2

期望
1

@VangelisHaha
Copy link

@VangelisHaha
Copy link

@ernest 两个群都显示无法加入,图上的内容就是Yapi文档接口详情页面的备注 栏 中的文字,是否支持一定方式进行定制

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jan 9, 2020

非常感谢有这样的工具让我司更加快速的创建接口,这真的非常棒。但是我司有一些自动化接口的需求,我们希望在接口文档中备注出去添加请求json示例状语从句:
可否请立即获取iTunes针对于图产品上备注信息的定制呢?非常感谢作者的开源。
很抱歉,图裂了,可以重新上传试试吗?或者可以加群qq644642474 @ernest返回json示例
图片

期望结果:
image-20200108192903222

图中备注处可以通过一定方式支持定制,而不是默认方法的代码
image-20200108193159595

看到图了,请问下需要使用json 的场景为? 这个改动比较大

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jan 9, 2020

期待支持一下pash 配置,现在上传的pash 是自动生成的.期待有个注解可以指定方法的path
之所以提这个需求是因为工程提供的接口是需要客户端通过网关接入的, 而网关对客户端暴露的接口地址是自定义的.

明白你的需求,放在1.7.8 后加入

1.7.8 已经上线

@boommanpro
Copy link

默认给出的参数示例不好用, 希望可以从注释上获取参数示例.

@boommanpro
Copy link

现在接口的备注 我看到是取得@RequestMapping 附近的代码,如果我手动添加了一些内容,在下一次更新接口的时候会覆盖掉,如何只覆盖前面部分,不覆盖后面的

@qbb-dev
Copy link
Contributor Author

qbb-dev commented Jan 10, 2020

现在接口的备注 我看到是取得@RequestMapping 附近的代码,如果我手动添加了一些内容,在下一次更新接口的时候会覆盖掉,如何只覆盖前面部分,不覆盖后面的

需要yapi 是carzy 分支的,官方版本的yapi 不支持

@swxu2005
Copy link

希望能支持 Map<String, Object> 类型的参数。由开发人员在注释中写明每个参数的意义

@swxu2005
Copy link

希望能支持Jackson的字段忽略注解:
@JsonIgnore@JsonProperty(access = JsonProperty.Access.READ_ONLY)等

@mengTnT
Copy link

mengTnT commented Mar 20, 2020

需求背景:每次修改完代码,比如改了注释,改了参数,都要手动提交一下文档到yapi,很麻烦,有时候
还会忘记。
具体需求:git上代码版本改变时,触发更新文档到yapi
十分感谢🙏

@wuwh3
Copy link

wuwh3 commented Apr 3, 2020

自动上传未识别@Api(value = "xx信息管理", description = "xx信息管理", tags = "xx信息管理")
标签管理的内容,直接以Controller类名作为分类名了,期望支持识别@Api

@Veiasai
Copy link

Veiasai commented Apr 8, 2020

你好 有没有可能支持在注释中写mock.js的定义?能够定义yapi的mock数据?
现在需要手动上yapi界面书写,但接口更新时会比较麻烦。

ps: 看了下代码发现已经支持
#63

@wapmnw
Copy link

wapmnw commented May 14, 2020

需求背景:请求参数的实体类是通过参数解析器注入的,这种是不需要写进请求参数。
image

期望需求:希望能实现参数屏蔽,不进行上传到请求参数中,对参数是否必须可以设置

@HackenPai
Copy link

如果在yapi后台配置了多个project时,使用插件上传API,默认只会上传到第一个project中,希望增加指定模块分别上传到指定project中

@yubaogu
Copy link

yubaogu commented Oct 12, 2020

增加指定字段过滤,有的字段接口中需要,但是暴露的是用作上下文处理,并不需要暴露再文档中

@xiongmingwu
Copy link

希望能统一配置公共的http head,比如说鉴权的场景需要传入token,但现在上传文档后,由于没地方输入token,导致无法在yapi上进行接口调试。

@FurionCS
Copy link
Collaborator

FurionCS commented Oct 18, 2020 via email

@Belep
Copy link

Belep commented Dec 4, 2020

上传时期待加入,com.fasterxml.jackson.annotation.JsonProperty注解的支持。
因为有时候可能会别名,或是用下滑线字段显示。

@weixiaohui-1
Copy link

可以添加Spring WebFlux的支持吗

@zhangbokang
Copy link

期望可以支持springdata的Page【org.springframework.data.domain.Page】,目前idea好像无法支持类似【CommonResult<Page>】这种的返回值的解析

@joeyFuck
Copy link

Map<String, Object> 类型的参数,怎么写注释呢?
现在map参数,生成文档后就一个参数 key

@ksfallen
Copy link

ksfallen commented Aug 17, 2021

期望可以支持解析第三方jar包里的类字段注释, 当jar包有下载源码时是可以看到注释的

试了下 api-generator 这个插件是兼容第三方jar包

可以参考下这个

@chimmhuang
Copy link

该类个别属性有doc注释,但是不需要上传到 yapi 的这种功能希望能拥有。

@nickevin
Copy link

nickevin commented Jan 1, 2022

希望支持按项目级别(所有的类、类中的方法)上传。

@AresKingCarry
Copy link

希望支持grpc接口文档上传

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests