springbootswagger2注解的用法-创新互联

这篇文章主要讲解了springboot swagger2注解的用法，内容清晰明了，对此有兴趣的小伙伴可以学习一下，相信大家阅读完之后会有帮助。

创新互联建站长期为千余家客户提供的网站建设服务，团队从业经验10年，关注不同地域、不同群体，并针对不同对象提供差异化的产品和服务；打造开放共赢平台，与合作伙伴共同营造健康的互联网生态环境。为白水企业提供专业的成都网站设计、成都做网站，白水网站改版等技术服务。拥有10余年丰富建站经验和众多成功案例,为您定制开发。

swagger2 注解整体说明  最近在使用Swagger的时候忘记了注解的用法，特此记录一下。

@Api：用在请求的类上，表示对类的说明
   tags="说明该类的作用，可以在UI界面上看到的注解"
   value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
 
 @ApiOperation：用在请求的方法上，说明方法的用途、作用
   value="说明方法的用途、作用"
   notes="方法的备注说明"
 
 @ApiImplicitParams：用在请求的方法上，表示一组参数说明
   @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
     name：参数名
     value：参数的汉字说明、解释
     required：参数是否必须传
     paramType：参数放在哪个地方
       · header --> 请求参数的获取：@RequestHeader
       · query --> 请求参数的获取：@RequestParam
       · path（用于restful接口）--> 请求参数的获取：@PathVariable
       · body（不常用）
       · form（不常用）  
     dataType：参数类型，默认String，其它值dataType="Integer"    
     defaultValue：参数的默认值
 
 @ApiResponses：用在请求的方法上，表示一组响应
   @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
     code：数字，例如400
     message：信息，例如"请求参数没填好"
     response：抛出异常的类
 
 @ApiModel：用于响应类上，表示一个返回响应数据的信息
       （这种一般用在post创建的时候，使用@RequestBody这样的场景，
       请求参数无法使用@ApiImplicitParam注解进行描述的时候）
   @ApiModelProperty：用在属性上，描述响应类的属性

另外有需要云服务器可以了解下创新互联建站www.cdcxhl.com，海内外云服务器15元起步，三天无理由+7*72小时售后在线，公司持有idc许可证，提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案，具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势，专为企业上云打造定制，能够满足用户丰富、多元化的应用场景需求。

本文标题：springbootswagger2注解的用法-创新互联
分享地址：http://shouzuofang.com/article/ceocgh.html