SpringBoot中引入Swagger2的使用

╰半夏微凉° 2022-04-01 04:38 308阅读 0赞

在我们基有的springcloud的项目结构上,需要引进整合所有的接口进行测试...

故引进swagger作为测试接口的方式,测试和api文档都比较清晰;

项目引入部分:

## //TODO ##

使用部分:

页面访问:host:port/swagger-ui.html

![20181229110552316.png][]

即引入成功.

在接口类,方法上只需要实现简单的几个注解就可以实现pai文档的生成,和测试方法了....

一般类上面就是

@Api注解.

![20181229110700829.png][]

方法上就是

@ApiOperation

@ApiImplicitParams(多个参数的使用)

@ApilmplicitParam(单个参数的使用)

![20181229110830781.png][]

简单的几个注解做下说明:

swagger常用的注解主要有:

*  Api
 *  ApiModel
 *  ApiModelProperty
 *  ApiOperation
 *  ApiParam
 *  ApiResponse
 *  ApiResponses
 *  ResponseHeader

## @Api ##

Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源，使用方式：

@Api(value = "/user", description = "Operations about user")

与Controller注解并列使用。 属性配置：

protocolsPossible values: http, https, ws, wss.authorizations高级特性认证时配置hidden配置为true 将在文档中隐藏

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td style="width:116px;">属性名称</td> 
   <td style="width:383px;">解释说明</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">value</td> 
   <td style="width:383px;">url的路径值</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">tags</td> 
   <td style="width:383px;"><span style="color:#f33b45;"><strong>如果设置这个值,value的值会被覆盖</strong></span></td> 
  </tr> 
  <tr> 
   <td style="width:116px;">description</td> 
   <td style="width:383px;">对api资源的描述</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">basePath</td> 
   <td style="width:383px;">基本路径可以不设置</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">position</td> 
   <td style="width:383px;">如果配置多个Api,想改变显示的顺序位置</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">produces</td> 
   <td style="width:383px;">如 "application/json, application/xml"</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">consumes</td> 
   <td style="width:383px;">如:"application/json, application/xml"</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">protocols</td> 
   <td style="width:383px;">如:http, https, ws, wss</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">authorizations</td> 
   <td style="width:383px;">高级特性认证时配置</td> 
  </tr> 
  <tr> 
   <td style="width:116px;">hidden</td> 
   <td style="width:383px;">配置为true 将在文档中隐藏</td> 
  </tr> 
 </tbody> 
</table>

//TODO

先关个禅道的bug,再回来写....

参考链接:[http://www.mamicode.com/info-detail-2213514.html][http_www.mamicode.com_info-detail-2213514.html]

[20181229110552316.png]: /images/20220401/e8d552f197414254921bf5d7c55ab339.png
[20181229110700829.png]: /images/20220401/1c629a764528400ca0d592380286d116.png
[20181229110830781.png]: /images/20220401/4c36d1f6145b45f1b7956503b1152859.png
[http_www.mamicode.com_info-detail-2213514.html]: http://www.mamicode.com/info-detail-2213514.html