Springboot配置Swagger2

方式：创建Java类来配置Swagger设置

1.在pom.xml添加依赖

        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-swagger2artifactId>
            <version>2.9.2version>
        dependency>

        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-swagger-uiartifactId>
            <version>2.9.2version>
        dependency>

1
2
3
4
5
6
7
8
9
10
11
12

2.创建Swagger的Java配置类

package com.yhq.logintest.Utils;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerUtil {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yhq.logintest.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(new ApiInfoBuilder()
                        .title("登陆测试")
                        .description("用于登陆测试")
                        .version("1.0")
                        .build());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

3.在启动类添加注解@EnableSwagger2

package com.yhq.logintest;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@SpringBootApplication
@MapperScan("com.yhq.logintest.mapper")
public class LoginTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(LoginTestApplication.class, args);
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

swagger2 相关注解说明

1.@Api

说明：用在请求的类上（controller），说明该类的作用
属性：tags=“说明该类的作用”，value=“该参数没什么意义，不需要配置”
示例：@Api(tags = “登陆”)

2.@ApiOperation

说明：用在请求的方法上，说明方法的作用
属性：value=“说明方法的作用”，notes=“方法的备注说明”
示例：@ApiOperation(value=“用户注册”，notes=“手机号，密码都是比输项，年龄限制为数字”)

3.@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

说明：用于请求的方法上，表示一组响应，@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{
    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;
    /* getter/setter */
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16