1.导入依赖
<!-- Swagger 导包 -->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.config文件夹添加SwaggerConfig.java配置类
@Configuration
@EnableSwagger2//开启Swagger2
public class SwaggerConfig {
//作者信息
public static final Contact DEFAULT_CONTACT = new Contact("哥", "http://localhost:8080/hello", "xxxxxxx@qq.com");
//配置了swagger Docket Bean实例,每一个Docket都是一个组,可以配置多个组
@Bean
public Docket docket(Environment environment){
//获取项目环境;debug 或 发布
Profiles dev = Profiles.of("dev");
//通过environment判断是否处于指定环境中
boolean flag = environment.acceptsProfiles(dev);
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("B组")
.enable(flag)//根据环境是否关闭启动 关闭后不能再使用swagger 不能在select()设置
.select()
//RequestHandlerSelectors 配置要扫描接口的方式
//basePackage("com.kuang.controller")指定要扫描的包
//any()扫描全部包
//none()都不扫描
//withClassAnnotation(RestController.class) 扫描类上的注解(只有类上有这个注解才会被扫描)
//withMethodAnnotation(GetMapping.class) 扫描方法上的注解(只有方法上有这个注解才会被扫描)
.apis(RequestHandlerSelectors.basePackage("com.kuang.controller"))
//只扫描http://localhost:8080/hello/ 下所有方法
.paths(PathSelectors.ant("/hello/**"))
.build();
}
@Bean
public Docket docket2(){
return new Docket(DocumentationType.SWAGGER_2).groupName("A组");
}
//配置Swagger信息=apiInfo
private ApiInfo apiInfo(){
return new ApiInfo("Api文档",
"再小的帆都能远航",
"1.0",
"urn:tos",
DEFAULT_CONTACT,
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList<VendorExtension>());
}
}
3.浏览器输入 http://localhost:8080/swagger-ui.html 测试
注意:java.lang.NumberFormatException: For input string: “” 错误解决方法
在实体类中 Integer和int字段的@ApiModelProperty(value = “主键ID”)加上 example = “1” 变成
@ApiModelProperty(value = “主键ID”,example = “1” )
Swagger注解详解
1、@Api:用在请求的类上,说明该类的作用
@Api:用在请求的类上,说明该类的作用
tags="说明该类的作用"
value="该参数没什么意义,所以不需要配置"
2、@ApiOperation:用在请求的方法上,说明方法的作用
@ApiOperation:"用在请求的方法上,说明方法的作用"
value="说明方法的作用"
notes="方法的备注说明"
@ApiOperation(value="用户注册",notes="手机号、密码都是必输项,年龄随边填,但必须是数字")
3、@ApiImplicitParams:用在请求的方法上,包含一组参数说明
@ApiImplicitParams:用在请求的方法上,包含一组参数说明
@ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一个请求参数的配置信息
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
示例
@ApiImplicitParams({
@ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
@ApiImplicitParam(name="password",value="密码",required=true,paramType="form"), @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer") })
4、@ApiResponses:用于请求的方法上,表示一组响应
@ApiResponses:用于请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
示例
@ApiOperation(value = "select1请求",notes = "多个参数,多种的查询参数类型")
@ApiResponses({
@ApiResponse(code=400,message="请求参数没填好"), @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") })
5、@ApiModel:用于响应类上,表示一个返回响应数据的信息
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,
请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性
示例
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
@ApiModel(description= “返回响应数据”)
public class RestMessage implements Serializable{
<span class="hljs-keyword">@</span><span class="hljs-keyword"><span class="hljs-keyword">ApiModelProperty</span>(<span class="hljs-keyword">value = <span class="hljs-string"><span class="hljs-string">"是否成功"</span>)
private boolean success=true;
<span class="hljs-keyword">@</span><span class="hljs-keyword"><span class="hljs-keyword">ApiModelProperty</span>(<span class="hljs-keyword">value = <span class="hljs-string"><span class="hljs-string">"返回对象"</span>)
private Object data;
<span class="hljs-keyword">@</span><span class="hljs-keyword"><span class="hljs-keyword">ApiModelProperty</span>(<span class="hljs-keyword">value = <span class="hljs-string"><span class="hljs-string">"错误编号"</span>)
private Integer errCode;
<span class="hljs-keyword">@</span><span class="hljs-keyword"><span class="hljs-keyword">ApiModelProperty</span>(<span class="hljs-keyword">value = <span class="hljs-string"><span class="hljs-string">"错误信息"</span>)
private String message;
<span class="hljs-comment"><span class="hljs-comment">/* getter/setter */</span>
}