SpringBoot中整合Swagger2接口文档

目录

1、maven依赖

 2、swagger2 注解整体说明

          2.1、请求类的描述

 2.2、方法和方法参数的描述

 2.3、方法的响应状态的描述

 2.4、对象的描述

 3、请求类的描述

3.1、@Api：请求类的说明

3.2、示例：

4、方法和方法参数的描述

4.1、@ApiOperation：方法的说明

4.2、示例：

4.3、@ApParam：方法参数的说明

4.4、示例：

---

1、maven依赖

 2、swagger2 注解整体说明

2.1、请求类的描述

注解	说明
@Api	对请求类的说明

 2.2、方法和方法参数的描述

注解	说明
@ApiOperation	方法的说明
@ApiParams	方法参数的说明；
@ApiParam	用于指定单个参数的说明。

3、请求类的描述

3.1、@Api：请求类的说明

@Api：放在 请求的类上。与 @Controller 并列，说明类的作用，如用户模块，订单类等。 tags="说明该类的作用"

value="该参数没什么意义，所以不需要配置"

3.2、示例：

@Api(tags = "班级管理器")
@RestController
@RequestMapping("/sms/clazzController")
public class ClazzController {
    ......

}

@Api 其它属性配置：

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
basePath	基本路径
position	如果配置多个Api 想改变显示的顺序位置

注：还有一些不常用的，没有放上来。

4、方法和方法参数的描述

4.1、@ApiOperation：方法的说明

@ApiOperation："用在请求的方法上，说明方法的作用"

value="说明方法的作用"

notes="方法的备注说明"

  4.2、示例：

@ApiOperation("回显搜索条件中的班级选项")
    @GetMapping("getClazzs")
        ......
    }

4.3、@ApParam：方法参数的说明

@ApiImplicitParams：用在请求的方法上，包含一组参数说明
    @ApiImplicitParam：对单个参数的说明        
        name：参数名
        value：参数的说明、描述
        required：参数是否必须必填
        paramType：参数放在哪个地方
            · query --> 请求参数的获取：@RequestParam
            · header --> 请求参数的获取：@RequestHeader          
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（请求体）-->  @RequestBody User user
            · form（普通表单提交）       
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

   4.4、示例：

 public Result deleteClazz(
            @ApiParam("要删除的多个班级的ID的JSON数组")@RequestBody List<Integer> ids
    ){
        ......
    }

 注意：本篇博客用于毕业答辩！！！毕设以外的没有涉及，顺利毕业以后再来补全！！！