项目开发-接口开发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插件中的注解

@GetMapping:方法注解，是Spring4.3提供的新注解,它是一个组合注解,等价于@RequestMapping(method = RequestMethod.Get ),用于简化开发,注意:@RequestMapping如果没有指定请求方式，将接收Get、Post、Head、Options等所有的请求方式.同理还有@PostMapping、@PutMapping、@DeleteMapping、@PatchMapping等
 

@ApiImplicitParams:方法注解，用来包含API的一组参数注解，可以简单的理解为参数注解的集合声明；属于swagger插件中的注解

@ApiImplicitParam:方法注解，用在@ApiImplicitParams注解中，也可以单独使用，说明一个请求参数的各个方面，该注解包含的常用选项有，数据swagger插件中的注解