xiaoymin / blog-comments

blog-comments
0 stars 0 forks source link

swagger-bootstrap-ui #71

Open xiaoymin opened 5 years ago

xiaoymin commented 5 years ago

http://doc.xiaominfo.com/

Vue 驱动的静态网站生成器

fondon commented 5 years ago

赞...

bosscloud commented 5 years ago

liyanpro commented 5 years ago

响应内容分层较多时页面加载不出来,目前超过四层就加载不出来了,大神能给解决一下吗

xiaoymin commented 5 years ago

@YahLee 响应内容分层较多时页面加载不出来,目前超过四层就加载不出来了,大神能给解决一下吗

提issue吧,描述越详细越好

scookiem commented 5 years ago

牛逼了大神

bone7System commented 5 years ago

如果是这种 /api/{id},这种path类型,好像无法解析到后台去,希望可以解决。

LisDocument commented 5 years ago

@bone7System 如果是这种 /api/{id},这种path类型,好像无法解析到后台去,希望可以解决。

如果是path格式,在curl中没有添加上去,且后台也无法正常解析

xiaoymin commented 5 years ago

@LisDocument

@bone7System 如果是这种 /api/{id},这种path类型,好像无法解析到后台去,希望可以解决。

如果是path格式,在curl中没有添加上去,且后台也无法正常解析

用最新版本1.9.6的,已经解决该问题

blrrryface commented 5 years ago

我特别想知道您主页的前端模板用的什么?看到不少作者都用这个风格的,很喜欢,有谁能告诉我吗?

xiaoymin commented 5 years ago

@fengyishun 我特别想知道您主页的前端模板用的什么?看到不少作者都用这个风格的,很喜欢,有谁能告诉我吗?

VuePress

这个站点的源码:https://github.com/xiaoymin/swagger-bootstrap-ui-doc

lizhongren031 commented 5 years ago

返回模型对象设置@ApiModelProperty(required = true)在响应参数没展现是必填值,原生的swagger有星号标注是必填值。

LemonKL commented 5 years ago

用着很方便

yzsunlight commented 5 years ago

确实很方便,不错不错

zuihou commented 4 years ago

评论怎么弄的

jianbo-chen commented 4 years ago

能加一个配置项可以实时修改请求url吗,不仅限于直接请求本地,可以指定网关调用

my-dlq commented 4 years ago

最新版本,调试中查询数据,第一次查询的数据前台展示后,同一个页面,设置不同参数再次查询,页面数据栏还保持第一次查询的结果无任何变化,前端设置已经将缓存关闭。

zhangyongxiao commented 4 years ago

jdk1.7支持吗

Cw404 commented 4 years ago

MarvelHub commented 4 years ago

在2.0.2后期能不能加一个简约版的Api注解,一个方法往往需要三四个Api相关的注解,再加上自身的注解一个方法往往会达到七八个注解,可读性变差了

javaliwen commented 4 years ago

很强,赞一个

CandyKIng1991 commented 4 years ago

最简单示例https://www.cnblogs.com/liuyangfirst/p/12900597.html

jtxf1 commented 4 years ago

Hello World!

git-ssyang commented 4 years ago

谁能给我个springmvc集成knife4j的demo,非常感谢

WangYekun commented 4 years ago

为什么控制层只有一个获取接口,然后在这个控制层下出现了add接口/all接口/list接口/update接口/get接口/remove接口/这些没有写入控制层的接口,使用的是springboot单体项目,如下依赖

com.github.xiaoymin knife4j-spring-boot-starter 2.0.2 com.spring4all swagger-spring-boot-starter 1.6.0.RELEASE

请问这个是因为什么呢?

bone7System commented 4 years ago

添加依赖设置一下就可以了吧。

------------------ 原始邮件 ------------------ 发件人: "Liu Tao"<notifications@github.com>; 发送时间: 2020年4月27日(星期一) 中午1:58 收件人: "xiaoymin/blog-comments"<blog-comments@noreply.github.com>; 抄送: "ゞ悱炷蓅灬亂"<1021169930@qq.com>;"Mention"<mention@noreply.github.com>; 主题: Re: [xiaoymin/blog-comments] swagger-bootstrap-ui (#71)

问一下, 官网这个ui是怎么弄的, 挺多开源框架都是用的这个ui, 自己的开源框架想把文档分析出来, 不知道怎么做成这个样子, 求回复

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

caiiansheng commented 4 years ago

能否作为一个api 显示的框架,导入其他手动写好的 api yaml

shiwei1986 commented 4 years ago

怎么设置部分接口开放给部分人看,就是权限控制的粒度到接口,求大神指点

zhoushisheng001 commented 4 years ago

接口排序不起作用

guangxs commented 4 years ago

作者您好,用了你的knife4j,我很喜欢,使用过程中有一个小问题,在向后台传参类型为array数组或者是集合之类的参数类型时无法设置多个参数,希望改进。支持!

CandyKIng1991 commented 4 years ago

首先,knife4j不是我开发的,是knife4j团队开发的,地址:https://doc.xiaominfo.com/guide/useful.html, 因为开源的所以文档写的不好,我只是写了一个更好的博客文档而已,所以,功能方面不是我这里负责,至于你提的问题,属于swagger使用问题,建议:

1、学习swagger注解的使用,比如:@RequestBody

public static String getUserList(@RequestBody List ids){ } 以前开发的使用,会这样传递集合类型的参数.

2、多参数这么使用@RequestParam @PutMapping("/save") public Boolean save(String clientId, @RequestParam(value = "powerClientIds")@ApiParam(value = "可被访问的clientId列表") List powerClientIds){ ........
returntrue; } 3、根据接口设计原则,尽量不要使用多个参数,最好的接口就传递一个参数,最多两个,如果超过,请设计成使用对象传递(出资《代码整洁之道》) 传递对象

public static String getUserList(@RequestBody User user){ } public static String getUserList(@RequestBody Map<String,Object> users){ } 不知道,是否解答您的疑惑,更多问题,请看https://www.cnblogs.com/liuyangfirst/,欢迎您的支持和点赞推荐

在 2020-08-02 16:09:01,"sursq" notifications@github.com 写道:

作者您好,用了你的knife4j,我很喜欢,使用过程中有一个小问题,在向后台传参类型为array数组或者是集合之类的参数类型时无法设置多个参数,希望改进。支持!

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

WangYekun commented 4 years ago

好的

------------------ 原始邮件 ------------------ 发件人: "xiaoymin/blog-comments" <notifications@github.com>; 发送时间: 2020年8月3日(星期一) 上午10:21 收件人: "xiaoymin/blog-comments"<blog-comments@noreply.github.com>; 抄送: "你还记得我吗"<849907942@qq.com>;"Comment"<comment@noreply.github.com>; 主题: Re: [xiaoymin/blog-comments] swagger-bootstrap-ui (#71)

首先,knife4j不是我开发的,是knife4j团队开发的,地址:https://doc.xiaominfo.com/guide/useful.html, 因为开源的所以文档写的不好,我只是写了一个更好的博客文档而已,所以,功能方面不是我这里负责,至于你提的问题,属于swagger使用问题,建议:

1、学习swagger注解的使用,比如:@RequestBody

public static String getUserList(@RequestBody List<String> ids){ } 以前开发的使用,会这样传递集合类型的参数.

2、多参数这么使用@RequestParam @PutMapping("/save") public Boolean save(String clientId, @RequestParam(value = "powerClientIds")@ApiParam(value = "可被访问的clientId列表") List<String> powerClientIds){ ........
returntrue; } 3、根据接口设计原则,尽量不要使用多个参数,最好的接口就传递一个参数,最多两个,如果超过,请设计成使用对象传递(出资《代码整洁之道》) 传递对象

public static String getUserList(@RequestBody User user){ } public static String getUserList(@RequestBody Map<String,Object> users){ } 不知道,是否解答您的疑惑,更多问题,请看https://www.cnblogs.com/liuyangfirst/,欢迎您的支持和点赞推荐

在 2020-08-02 16:09:01,"sursq" <notifications@github.com> 写道:

作者您好,用了你的knife4j,我很喜欢,使用过程中有一个小问题,在向后台传参类型为array数组或者是集合之类的参数类型时无法设置多个参数,希望改进。支持!

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe. — You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

Hi-ZYQ commented 4 years ago

qq浏览器和360浏览器好像打不开

YAGAMIL commented 4 years ago

仅仅配合swagger使用

com.github.xiaoymin knife4j-spring-ui 2.0.4

文档页面的响应参数及响应示例请求参数都是NoData

xiaoymin commented 4 years ago

qq浏览器和360浏览器好像打不开

以Chrome浏览器和Firefox为准

ghlhj commented 4 years ago

验证码接口没有想swaggerui那样以图片的形式展示

CandyKIng1991 commented 4 years ago

都用谷歌,谁用那个浏览器,浏览器兼容性,你自己去官网问去

在 2020-08-06 13:29:13,"ZYQ" notifications@github.com 写道:

qq浏览器和360浏览器好像打不开

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

CandyKIng1991 commented 4 years ago

因为你配置的不对,而且我这写的不是1.9.6吗。新版本自己测试

在 2020-08-07 14:23:41,"YAGAMIL" notifications@github.com 写道:

仅仅配合swagger使用

com.github.xiaoymin knife4j-spring-ui 2.0.4

文档页面的响应参数及响应示例请求参数都是NoData

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

CandyKIng1991 commented 4 years ago

觉得不好,自己开发

在 2020-08-07 16:25:22,"ghlhj" notifications@github.com 写道:

验证码接口没有想swaggerui那样以图片的形式展示

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

yang894811087 commented 4 years ago

QwQ,怎么测试文件下载接口啊,我写了个需要加token验证的文件下载接口,用浏览器测试不能加token,用这个加了token请求后并没有下载,而是展示了一堆乱码,是我哪里没有配置好吗QwQ大佬们帮帮忙啊

xiaoymin commented 4 years ago

如果有一个全局的开关就好了,控制是否启用knife4j,甚至swagger-ui.html都不让访问最好,可以做到测试和生产的隔离

这种其实比较简单,你的Swagger配置写到一个Configuration里面,在这个类上使用Spring的@Profile注解就可以了

lvyi21 commented 4 years ago

模型中只有get的属性不能显示,或者set的可访问性不是public也不能显示,要怎么控制它显示出来呢?

lvyi21 commented 4 years ago

模型中为enum类型的属性注释显出不出来

CandyKIng1991 commented 4 years ago

加注释呗

在 2020-10-13 10:14:35,"lvyi21" notifications@github.com 写道:

模型中只有get的属性不能显示,或者set的可访问性不是public也不能显示,要怎么控制它显示出来呢?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

CandyKIng1991 commented 4 years ago

那就百度下,查看下枚举类型的这个字段如何显示,换个注解

在 2020-10-13 10:16:14,"lvyi21" notifications@github.com 写道:

模型中为enum类型的属性注释显出不出来

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

CandyKIng1991 commented 4 years ago

这个可以自己开发,添加个配置在yml里,然后启动的时候判断下,如果需要使用,就配置true,反之配置false

在 2020-09-28 15:39:01,"LmingXie" notifications@github.com 写道:

如果有一个全局的开关就好了,控制是否启用knife4j,甚至swagger-ui.html都不让访问最好,可以做到测试和生产的隔离

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

zngxyn commented 4 years ago

@ApiModelProperty(value = "账号", required = true) 必填字段在界面上显示还是false?要怎么处理?

CandyKIng1991 commented 4 years ago

那单词不写了吗,required 需要,true就是需要,false就是不需要,百度下不行吗 或者在博客里找https://www.cnblogs.com/liuyangfirst/default.html?page=3

在 2020-10-16 11:25:22,"xiaoyun.zeng" notifications@github.com 写道:

@ApiModelProperty(value = "账号", required = true) 必填字段在界面上显示还是false?要怎么处理?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

chinalsl commented 4 years ago

点个赞,1.8开始用的

zngxyn commented 4 years ago

@CandyKIng1991 那单词不写了吗,required 需要,true就是需要,false就是不需要,百度下不行吗 或者在博客里找https://www.cnblogs.com/liuyangfirst/default.html?page=3

在 2020-10-16 11:25:22,"xiaoyun.zeng" notifications@github.com 写道:

@ApiModelProperty(value = "账号", required = true) 必填字段在界面上显示还是false?要怎么处理?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

我代码里写的required = true,但是文档出来的不是必填,把版本降级到2.0.4就是显示对了

CandyKIng1991 commented 4 years ago

f12找呗,这是前端问题,你让前段给你看呗

在 2020-11-07 16:19:48,"jiajianqing" notifications@github.com 写道:

如果带有token的 如何联调测试?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.