原因

在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的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。