long blogs

进一步有进一步惊喜


  • Home
  • Archive
  • Tags
  •  

© 2025 long

Theme Typography by Makito

Proudly published with Hexo

SpringBoot整合Swagger

Posted at 2019-08-14 笔记 spring 

一、相关的配置

1、maven引入swagger2依赖

1
2
3
4
5
6
7
8
9
10
11
<!--添加swagger依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>

2、swagger的配置类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("考试管理的接口")
                .contact(new Contact("我的姓名","http://long95288.github.io","123456@xx.com"))
                .version("1.0")
                .description("这个接口是用来给前端的测试接口的")
                .build();
    }
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bosssoft.hr.train.bes.exam.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}
  • 类头的@Configuration是spring 配置类的注解
  • @EnableSwagger2是必须的用来开启swagger2
  • ApiInfo主要是对接口文档的一些说明
    1、title文档的标题
    2、Contact(name,url,email) 作者相关信息
    3、version 版本号
    4、description()对该文档的描述
  • 上述配置的效果为:

二、使用swagger

1、相关注解说明

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
28
29
30
31
32
@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

2、使用注解

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@Api(tags = "tags 类的描述 Swagger控制器",value = "@Api value Swagger控制器")
@RestController
@RequestMapping("swagger")
public class SwaggerController {


    @ApiOperation(value = "接口说明",notes = "接口备注 输入message 返回Hello Swagger Message")
    @RequestMapping(value = "/hello",method = RequestMethod.POST)
    public String helloSwagger(@RequestParam("message") String message){
        System.out.println("Hello Swagger" + message);
        return "Hello Swagger "+ message;
    }

    @ApiOperation(value = "add",notes = "a + b")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "a",value = "1",paramType = "query"),
            @ApiImplicitParam(name = "b",value = "2",paramType = "query")
    })
    @RequestMapping(value = "/add",method = RequestMethod.POST)
    public int add(@RequestParam("a") int a,@RequestParam("b") int b){
        int c = a + b;
        return c;
    }
}

4、使用效果

Share 

 Previous post: Mybatis整合通用mapper Next post: UML文档编写 

© 2025 long

Theme Typography by Makito

Proudly published with Hexo