swagger2 description is deprecated

原因

在2.x之前，可以这么使用在Controller类上：
@Api(value= "PmsBrandController", description = "商品品牌管理")
但是在2.x中，description被弃用了。
原因在于在2.x中有了标签（tags）的概念，可以将不同的controller标记为同一个标签。使标签的分组机制更加灵活。
为了符合API的要求，保持向后兼容，保留了description字段。
现在正确的方法应当针对tags做出描述。

解决方法

先在SwaggerConfig中定义好 tags 的名称和描述。

@Configuration
@EnableSwagger2
public class SwaggerConfig {public static final String TAG_1 = "tag1";public static final String TAG_2 = "tag2";public static final String TAG_3 = "tag3";@Beanpublic Docket productApi() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.basePackage("my.package")).build().apiInfo(apiInfo()).tags(new Tag(TAG_1, "Tag 1 description.")).tags(new Tag(TAG_2, "Tag 2 description.")).tags(new Tag(TAG_3, "Tag 3 description."));}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("My API").version("1.0.0").build();}
}

然后在controller上添加一个定义好的 tag 即可。

@Api(tags = { SwaggerConfig.TAG_1 })
@RestController
@RequestMapping("tag1Domain")
public class Tag1RestController { ... }

swagger2 description is deprecated相关推荐

Swagger2 简明教程
Swagger2 简明教程一.什么是swagger 二.配置swagger 三.Swagger常用注解四.导出swagger接口文档一.什么是swagger Swagger 是一个规范和完整的框 ...
整合swagger2生成Restful Api接口文档
整合swagger2生成Restful Api接口文档 swagger Restful文档生成工具 2017-9-30 官方地址:https://swagger.io/docs/specificati ...
SpringBoot2.x整合Swagger2 实现API文档实时生成
我们提供Restful接口的时候,API文档是尤为的重要,它承载着对接口的定义,描述等,本文主要介绍了SpringBoot集成Swagger2生成接口文档的方法示例,需要的朋友们下面随着小编来一起学习 ...
Swagger2详解
一.Swagger注解 1.1 @Api 用在请求的类上,表示对类的说明 public @interface Api {//说明接口,无实际作用String value() default " ...
springboot整合 swagger2
springboot整合 swagger2 引入依赖 <dependency><groupId>io.springfox</g ...
springboot 整合 swagger2 配置账号密码登录 demo代码
配置spring security登录可参考: springboot整合spring security安全框架-简单验证账号密码一.pom文件引入swagger依赖 <!-- swagger2 ...
rust盖错了怎么拆除_细说Rust错误处理
细说Rust错误处理 1. 前言这篇文章写得比较长,全文读完大约需要15-20min,如果对Rust的错误处理不清楚或还有些许模糊的同学,请静下心来细细阅读.当读完该篇文章后,可以说对Rust的错误 ...
2018年排名Top 100的Java类库——在分析了277,975份源码之后得出的结论
最近,OveOps公布了The Top 100 Java Libraries in 2018 - Based on 277,975 Source Files,Hollis查看了这份榜单,做了翻译和补充 ...
使用Swagger UI的Document和Test API
目录介绍配置可视化测试支持属性支持XML文档资源/材料/参考资料介绍开发人员通常通过浏览器请求或使用POSTMAN, Advanced Rest Client(ARC)等客户端来测 ...

swagger2 description is deprecated

原因

解决方法

swagger2 description is deprecated相关推荐

最新文章

热门文章