【swagger2】swagger2配置显示及修改描述

本文档主要介绍如何使用Swagger2实现接口文档的中文显示及隐藏无用的Controller。通过@Api添加tags属性实现中文描述,@ApiIgnore或设置hidden=true隐藏Controller,但YAPI可能存在缓存,需手动清除。
摘要由CSDN通过智能技术生成

需求描述

项目接口文档使用yapi来进行管理,原来的controller仅使用了一个@Api的注解,且注解的描述是controller类名,添加@ApiOperation、@ApiModel和@ApiModelProperty后,第一次生成接口-接口列表下的分组是现在@Api配置的名称,业务和产品要看这个接口,显示controller类名,并不友好,我想改成中文,结果代码重启后,刷新yapi页面不变,即笔者修改的名称并未生效,所以产生了一个问题,怎么让中文名显示呢?除此之外,还有另外一个问题,有一个TestController也显示在接口列表的分组中了,笔者不想显示这个无用的列表,那该怎么隐藏呢?

yapi中的swagger文档生成

注:上图为yapi中同步swagger,生成接口文档的操作页面;其中swagger json地址的ip可以是本地ip,但不能写localhost,也可以是服务器ip,后面的资源地址应该是swagger文档固定地址吧;但需要注意的一点是,如果项目url有前缀,那么/v2/api-docs前要加上这个前缀,在项目程序启动后,可以搜索如下这句话看是什么前缀


                
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值