762 Star 6.6K Fork 1.4K

GVP萧明 / knife4j

 / 详情

Knife4j 提ISSUES必看

待办的
拥有者
创建于  
2019-07-29 09:56

虽然建立了交流群,但是很多没有加群的朋友会通过ISSUES来反馈问题,提ISSUES本身是一个很好的技术习惯,这有助于Knife4j的发展,同时也能帮助更多的开发者从issue中找到问题所在。

但如何提一个好的issue非常重要,这有助于帮助捉着能很好的定位问题所在,因为作者并不是实时关注,所以经常在处理issues的时候,看到很多朋友提的问题却也无从着手,写下一些建议,希望提issue的朋友能在提的时候都有涉及到:

1、针对如何使用的问题,建议使用Knife4j的标签在开源中国社区进行提问以寻求帮助:https://www.oschina.net/question/ask?tag=swagger-bootstrap-ui

或者关注Knife4j的微信公众号,加入讨论群寻求帮助

2、 Knife4j和springfox-swagger、springdoc-openapi、Spring Boot等版本号 ,这个尤为重要,很多低版本出现的问题有可能我在新发布的版本中已经解决了,每个版本都有更新日志,可以参考这篇文档:https://doc.xiaominfo.com/knife4j/changelog/
贴上版本的信息有助于作者更快的定位到问题

3、 提issue时贴图、贴代码,贴错误异常日志 ,代码不用贴逻辑,只需要贴接口层即可,还有 相关的实体类 (如果有涉及的话),有些问题可能是需要一连串的动作,希望能贴整个顺序图,帮助我复现Bug,这些信息有助于我快速定位问题,省去了来回沟通的成本,提高大家的效率

4、在交流群沟通的朋友我也希望能通过提ISSUE来记录下我们沟通的过程,我并非实时处理此问题,这让我集中再处理issues的时候有助于拉回我们彼此沟通时的场景,最终在新版本解决问题

5、一句简单的话不足以概括所有的信息一律当无效关闭处理

希望大家提issues的时候多一些信息,也省去大家交流的时间成本,避免浪费大家精力。

提issues信息不全的(我看不明白,特别是那种我还要问版本号之类的)我会直接关闭处理。请大家理解

举个很简单的例子,你可能发现了Knife4j的问题,提了issue给作者(这很好),但是作者可能等了2天(这不是我的主职工作,我也不会全天24小时盯着通知回复问题)才来处理issue,此时,你提的issue中,即没有版本、也没有贴图,就三言两语描述了一下,那作者处理issue时,需要回复询问得到更多的信息来将两人的沟通拉回一个视线上,以确定到底是Knife4j的问题,还是别的什么原因呢,这一来一回的,半个月可能都过去了,这纯浪费大家时间。

评论 (11)

萧明 创建了任务
萧明 置顶等级设置为
萧明 优先级设置为主要
萧明 修改了描述
萧明 任务状态待办的 修改为进行中
萧明 修改了标题
萧明 修改了描述
萧明 任务状态进行中 修改为待办的
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
展开全部操作日志

返回的接口对象继承了HashMap后,将所有的参数都放到这个map中返回,然后就获取不到对应的响应信息了

这个问题解决了吗,我也遇到这个问题了,加了增强注解@DynamicResponseParameters 注解,也还是不显示

代码中参数或响应中定义的类似于pCode、pId的属性,在knife4j页面中显示为pcode、pid(全为小写了)。但是类似于provCode的属性可以正常显示为provCode(正常区分大小写)。这是为啥?

这个驼峰命名不规范,springfox给你自动处理了的,第二个字母不能大写

好的,感谢!

作者你好!最近在做knife4j整合jsr validator,看到已关闭的issue上面的demo有个疑问,通过validator的groups来区分新增、修改数据时的必填项,是否springfox本身实现并不支持?而是把所有groups校验规则合并了?

springfox通过plugin来实现的,具体细节我有些忘了,他有一个配置类是BeanValidatorPluginsConfiguration.java

里面包含了他所有的实现,可以看看代码

多谢多谢!

萧明 修改了描述
萧明 修改了描述
萧明 修改了描述
com.github.xiaoymin knife4j-openapi3-spring-boot-starter 4.1.0

使用这个,
然后配置:knife4j:enable: true
然后使用 @ApiSupport>@ApiSort>@Api 这些注解。
没有正常的进行排序。

官方文档里强调了使用“knife4j-openapi2-spring-boot-starter”才行 :eyes:

我这样排序的,你可以试试。
输入图片说明

登录 后才可以发表评论

状态
负责人
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
参与者(8)
118100 xiaoym 1578918321 788689 passerr 1578932859
Java
1
https://gitee.com/xiaoym/knife4j.git
git@gitee.com:xiaoym/knife4j.git
xiaoym
knife4j
knife4j

搜索帮助

53164aa7 5694891 3bd8fe86 5694891