Swagger提供的经常使用的注解有：web
@Api：用在类上，说明该类的做用spring
@ApiOperation：用在方法上，说明方法的做用，标注在具体请求上，value和notes的做用差很少，都是对请求进行说明；tags则是对请求进行分类的，好比你有好几个controller，分别属于不一样的功能模块，那这里咱们就能够使用tags来区分了。后端
@ApiImplicitParams：用在方法上包含一组参数说明api
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面。springboot
@ApiResponses：用于表示一组响应框架
@ApiResponse：用在@ApiResponses中，通常用于表达一个错误的响应信息svg
@ApiModel：描述一个Model的信息（这种通常用在post建立的时候，使用@RequestBody这样的场景，请求参数没法使用@ApiImplicitParam注解进行描述的时候）代表这是一个被swagger框架管理的model，用于class上post
@ApiModelProperty： 这里顾名思义，描述一个model的属性，就是标注在被标注了@ApiModel的class的属性上，这里的value是对字段的描述，example是取值例子，注意这里的example颇有用，对于先后端开发工程师理解文档起到了关键的做用，由于会在api文档页面上显示出这些取值来；这个注解还有一些字段取值，能够本身研究，举例说一个：position，代表字段在model中的顺序。.net
与springboot集成能够看->《SpringBoot2.0集成Swagger2，生成RESTful API在线文档接口》
http://www.javashuo.com/article/p-xxsjirsp-cg.htmlxml