项⽬开发-接⼝开发API⽂档常⽤的注解
DTO:
@Data: 类注解，作⽤于实体类的setter和getter的⽣成，属于lombok插件中的注解，如果该字段被final修饰，则不会⽣成setter⽅法
@ApiModel：类注解，作⽤于接⼝⽂档的实体类的描述
@ApiModelProperty：属性注解，⽤于⽅法，字段； 表⽰对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
Service:
@Service:service标注业务层组件，标注将这个类交给Spring容器管理，spring容器要为他创建对象
@Resource：默认按name注⼊，可以通过name和type属性进⾏选择性注⼊
Controller:
@RestController：
1）类注解，相当于@ResponseBody ＋ @Controller合在⼀起的作⽤；
2）如果只是使⽤@Controller注解Controller，则Controller中的⽅法⽆法返回jsp页⾯，配置的视图解析器InternalResourceViewResolver不起作⽤，返回的内容就是Return ⾥的内容；
3）如果需要返回到指定页⾯，则需要⽤ @Controller配合视图解析器InternalResourceViewResolver才⾏；
4）如果需要返回JSON，XML或⾃定义mediaType内容到页⾯，则需要在对应的⽅法上加上@ResponseBody注解。
@RequestMapping：注解可以在控制器类的级别和/或其中的⽅法的级别上使⽤。映射URL
类定义处：规定初步的请求映射，相对于web应⽤的根⽬录；
⽅法定义处：进⼀步细分请求映射，相对于类定义处的URL。如果类定义处没有使⽤该注解，则⽅法标记的URL相对于根⽬录⽽⾔；
@Api：类注解，⽤在controller上，对controller进⾏注释；属于swagger插件中的注解
@Autowired：属性注解，默认按type注⼊
@ApiOperation:⽅法注解，⽤在API⽅法上，对该API做注释，说明API的作⽤；属于swagger插件中的注解resource和autowired注解的区别
@GetMapping:⽅法注解，是Spring4.3提供的新注解，它是⼀个组合注解，等价于@RequestMapping(method = RequestMethod.Get ),⽤于简化开发，注意:@RequestMapping如果没有指定请求⽅式，将接收Get、Post、Head、Options等所有的请求⽅式.同理还有
@PostMapping、@PutMapping、@DeleteMapping、@PatchMapping等
@ApiImplicitParams:⽅法注解，⽤来包含API的⼀组参数注解，可以简单的理解为参数注解的集合声明；属于swagger插件中的注解
@ApiImplicitParam:⽅法注解，⽤在@ApiImplicitParams注解中，也可以单独使⽤，说明⼀个请求参数的各个⽅⾯，该注解包含的常⽤选项有，数据swagger插件中的注解

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。