SpringBoot中引入Swagger2的使用

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

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

 

项目引入部分:

 

//TODO

 

 

使用部分:

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

SpringBoot中引入Swagger2的使用_第1张图片

即引入成功.

 

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

一般类上面就是

@Api注解.

SpringBoot中引入Swagger2的使用_第2张图片

方法上就是

@ApiOperation

@ApiImplicitParams(多个参数的使用)

@ApilmplicitParam(单个参数的使用)

SpringBoot中引入Swagger2的使用_第3张图片

 

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

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 将在文档中隐藏

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

 

//TODO 

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

 

 

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

你可能感兴趣的:(微服务)