情景:
在我们开发过程中,有时候会遇到我们需要将几个类中的方法集中到一个类中,但是我们又不希望把我们的原来的类删掉(就是单纯的不想删除,都是我写的代码我不想杀死我的结晶,不能说我写的是shi)。那么我们就要用到这个注解了。
注解使用后就是这样,是不是很装b呢,非常的有b格啊!!!
讲解:
@Deprecated
在 Swagger 中,要使一个类在文档中显示为过时(deprecated),可以使用 @Deprecated
注解,同时配合 Swagger 的 @ApiOperation(方法使用)
和 @Api(类使用)
注解。
举个栗子
@Deprecated
@Api(value = "过时的 API", description = "这个类已经过时,请使用新的 Controller 类")
@RestController
@RequestMapping("/api/old")
public class OldApiController {
@Deprecated
@ApiOperation(value = "旧端点", notes = "这个端点已经过时,请使用 /api/new/endpoint 端点")
@GetMapping("/endpoint")
public String oldEndpoint() {
return "This endpoint is deprecated";
}
}
这段通用解释性的代码中表明,我们对类或者方法都可以使用@Deprecated注解,表明类或方法过时,并且在@ApiOperation
和 @Api中可以使用value表明这个类或方法是过时的,并且可以使用notes来解释为什么被弃用了。
大家都去试试吧,加油学习,每日进步!!!