SpringBoot中使用怎么Swagger
SpringBoot中使用怎么Swagger
本篇内容主要讲解“SpringBoot中使用怎么Swagger”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带大家学习“SpringBoot中使用怎么Swagger”吧!
整合Swagger
依赖：
<!--Swagger--><dependency><groupId>com.battcn</groupId><artifactId>swagger-spring-boot-starter</artifactId><version>2.1.5-RELEASE</version></dependency>
我这里的Swagger大家应该也发现了，并非是官方的，这个是第三方整合的，配置更加简单。
配置详解
详细配置：
spring:swagger:enabled:truetitle:标题description:描述信息version:系统版本号contact:name:维护者信息base-package:swagger扫描的基础包，默认：全扫描(分组情况下此处可不配置)#全局参数,比如Token之类的验证信息可以全局话配置global-operation-parameters:-description:"Token信息,必填项"modelRef:"string"name:"Authorization"parameter-type:"header"required:truegroups:basic-group:base-package:com.battcn.controller.basicsystem-group:base-package:com.battcn.controller.system
我的配置
spring:swagger:title:星空小屋-文章微服务接口description:文章微服务相关接口，包括文章、模块、知识点管理等version:1.0.0-SNAPSHOTcontact:name:cv大魔王email:1919301983@qq.comhost:localhostenabled:truesecurity:filter-plugin:true#配置账号密码username:rootpassword:root
配置拦截器，后面有拦截器配置，如果有读者需要在自己的项目使用，请原有的拦截器配置中修改，忽略掉以下路径，以免被拦截导致无法访问。“swagger-ui.html”, “static/css/", "static/js/”, “swagger-resources”, “/**/error”, “v2/api-docs”
测试使用
运行项目，访问IP+端口号/swagger-ui.html，例如在浏览器访问：http://127.0.0.1:13001/swagger-ui.html
登录后的效果：
复习――常用注解
对swagger熟悉的小伙伴的请忽略“常用注解段落”
`@Api`：用在Controller类上，描述该类的作用1.`value`="描述信息"2.`description`="详细描述该类的作用"
@ApiOperation：用在 Controller 请求方法上，描述方法的作用。
@ApiModel：用在请求参数是对象上，描述该对象类的作用
//在对象类上使用@ApiModel@ApiModel(value="CategoryREQ对象",description="类别查询条件")publicclassCategoryREQextendsBaseRequest<Category>{}
@ApiModelProperty：用在请求参数是对象的属性上，描述对象属性的作用。
value：属性的描述hidden：是否是查询条件属性, false:(默认值)在api文档显示，作为查询条件；true 隐藏，不是条件属性
//请求方法参数是CategoryREQ对象publicResultsearch(@RequestBodyCategoryREQreq){}@ApiModel(value="CategoryREQ对象",description="类别查询条件")publicclassCategoryREQextendsBaseRequest<Category>{@ApiModelProperty(value="分类名称")privateStringname;@ApiModelProperty(value="状态(1:正常，0:禁用)")privateIntegerstatus;}
@ApiResponses：用在请求的方法上，用于表示一组响应@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息，注解参数：code：数字，如 400message：信息，如 “参数填写错误”response：抛出异常的类
@ApiIgnore: 使用该注解忽略这个 API
@ApiImplicitParams：用在请求方法上，对多个请求参数增加描述
@ApiImplicitParam：可单独使用，或在 @ApiImplicitParams 中使用，给方法的一个请求参数增加描述。
name：参数名value：描述参数的作用dataType：参数类型，参数类型，默认String，其它值 dataType=“Integer”defaultValue：参数默认值required：参数是否必传（true/false）paramTpye：指定参数放在哪些地方（header/query/path/body/form）
header：参数在request headers 里边提交 @RequestHeaderquery：直接跟参数完成自动映射赋值 @RequestParampath：以路径变量的形式提交数据 @PathVariablebody：以流的形式提交 仅支持POST（不常用）form：以form表单的形式提交 仅支持POST （不常用）
参考：
//请求方法有多个请求参数size，current@ApiImplicitParams({@ApiImplicitParam(name="current",value="页码",required=true,paramType="path",dataType="int"),@ApiImplicitParam(name="size",value="每页记录数",required=true,paramType="path",dataType="int")})@ApiOperation("根据分类名称与状态查询分类列表接口")@PostMapping("/search/{current}/{size}")Resultsearch(@RequestBodyCategoryREQreq,@PathVariableintcurrent,@PathVariableintsize);
到此，相信大家对“SpringBoot中使用怎么Swagger”有了更深的了解，不妨来实际操作一番吧！这里是恰卡编程网网站，更多相关内容可以进入相关频道进行查询，关注我们，继续学习！
