SrpingBoot使用Swagger2构建API文档

最新推荐文章于 2022-11-18 09:22:52 发布

北极熊的微笑

最新推荐文章于 2022-11-18 09:22:52 发布

阅读量259

点赞数

分类专栏： SpringBoot 文章标签： java Swagger2 SpringBoot

本文链接：https://blog.csdn.net/lpCrazyBoy/article/details/112219352

版权

SpringBoot 专栏收录该内容

12 篇文章 2 订阅

订阅专栏

Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：

整合Swagger2的步骤如下：

1、添加Swagger2依赖

<!-- swagger pom 依赖 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

2、创建Swagger2配置类

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swaggerdemo"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("这是添加的描述内容")
                .version("1.0")
                .build();
    }
}

（备注：创建在Application启动文件同一目录下）

3、在相应的Controller中添加文档内容

在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。如下所示，我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。

@RestController
@RequestMapping("/user")
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @ApiOperation(value="获取用户", notes="根据用户ID获取用户对象")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "integer")
    @RequestMapping(value = "/find_user", method = RequestMethod.POST)
    public Map<String, Object> GetUser(@RequestParam(value = "id", defaultValue = "0") int id){
        User user = userService.findUserById(id);
        if (user != null) {
            return HttpUtils.getResponse(1, user, "请求成功");
        }
        return HttpUtils.getResponse(0, null, "请求失败");
    }

    @ApiOperation(value="用户更新", notes="修改用户姓名")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "integer"),
            @ApiImplicitParam(name = "userName", value = "用户姓名", required = true, dataType = "String")
    })
    @RequestMapping(value = "/update_user", method = RequestMethod.POST)
    public String updateUserName(@RequestParam(value = "id", defaultValue = "0") int id
            , @RequestParam(value = "userName", defaultValue = "") String userName) {
        int result = userService.updateUserName(id, userName);
        return "执行完成" + result;
    }

    @ApiOperation(value="用户添加", notes="通过传递User对象来添加用户")
    @ApiImplicitParam(name = "user", value = "用户实体对象", required = true, dataType = "User")
    @RequestMapping(value = "/add_user", produces = "application/json;charset=UTF-8", method = RequestMethod.POST)
    public Map<String, Object> addUser(@RequestBody User user) {
        int result = userService.addUser(user);
        if (result > 0) {
            return HttpUtils.getResponse(HttpUtils.REQUEST_SUCCESS, null, CodeMessage.MSG_REQUEST_SUCCESS);
        } else {
            return HttpUtils.getResponse(HttpUtils.REQUEST_FAILED, null, CodeMessage.MSG_REQUEST_FAILED);
        }
    }

    @ApiOperation(value="获取用户列表", notes="获取所有用户列表")
    @RequestMapping(value = "/all_user", method = RequestMethod.POST)
    public Map<String, Object> getAllUser() {
        List<User> userList = userService.getAllUser();
        if (userList.size() > 0) {
            return HttpUtils.getResponse(HttpUtils.REQUEST_SUCCESS, userList, CodeMessage.MSG_REQUEST_SUCCESS);
        } else {
            return HttpUtils.getResponse(HttpUtils.REQUEST_FAILED, null, CodeMessage.MSG_REQUEST_FAILED);
        }
    }

    @ApiOperation(value="用户删除", notes="根据用户ID来删除用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "integer")
    @RequestMapping(value = "/delete_user", method = RequestMethod.POST)
    public Map<String, Object> deleteUser(@RequestParam(value = "id", defaultValue = "0") int id){
        int result = userService.deleteUser(id);
        if (result > 0) {
            return HttpUtils.getResponse(1, null, "删除成功");
        }
        return HttpUtils.getResponse(0, null, "删除失败");
    }
}

4、完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html

附加：

Swagger2常用注解说明

一、@Api

用在请求的类上，表示对类的说明

常用参数：

tags="说明该类的作用，非空时将覆盖value的值"
value="描述类的作用"
description           对api资源的描述，在1.5版本后不再支持
basePath              基本路径可以不配置，在1.5版本后不再支持
position              如果配置多个Api 想改变显示的顺序位置，在1.5版本后不再支持
produces              设置MIME类型列表（output），例："application/json, application/xml"，默认为空
consumes              设置MIME类型列表（input），例："application/json, application/xml"，默认为空
protocols             设置特定协议，例：http， https， ws， wss。
authorizations        获取授权列表（安全声明），如果未设置，则返回一个空的授权值。
hidden                默认为false， 配置为true 将在文档中隐藏

示例：

@Api(tags="登录请求")
@Controller
@RequestMapping(value="/highPregnant")
public class LoginController {}

二、@ApiOperation

用在请求的方法上，说明方法的用途、作用

常用参数：

value="说明方法的用途、作用"
notes="方法的备注说明"
tags                操作标签，非空时将覆盖value的值
response            响应类型（即返回对象）
responseContainer   声明包装的响应容器（返回对象类型）。有效值为 "List", "Set" or "Map"。
responseReference  指定对响应类型的引用。将覆盖任何指定的response（）类
httpMethod        指定HTTP方法，"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"
position            如果配置多个Api 想改变显示的顺序位置，在1.5版本后不再支持
nickname         第三方工具唯一标识，默认为空
produces            设置MIME类型列表（output），例："application/json, application/xml"，默认为空
consumes            设置MIME类型列表（input），例："application/json, application/xml"，默认为空
protocols           设置特定协议，例：http， https， ws， wss。
authorizations      获取授权列表（安全声明），如果未设置，则返回一个空的授权值。
hidden              默认为false， 配置为true 将在文档中隐藏
responseHeaders       响应头列表
code            响应的HTTP状态代码。默认 200
extensions       扩展属性列表数组

示例：

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@RequestParam(value = "name", required = false) String account, @RequestParam(value = "pass", required = false) String password){}

三、@ApiImplicitParams

用在请求的方法上，表示一组参数说明

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

常用参数：

name：参数名，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
value：参数的汉字说明、解释
required：参数是否必须传，默认为false [路径参数必填]
paramType：参数放在哪个地方
    · header --> 请求参数的获取：@RequestHeader
    · query --> 请求参数的获取：@RequestParam
    · path（用于restful接口）--> 请求参数的获取：@PathVariable
    · body（不常用）
    · form（不常用）
dataType：参数类型，默认String，其它值dataType="Integer"
defaultValue：参数的默认值
其他参数：

allowableValues    限制参数的可接受值。1.以逗号分隔的列表   2、范围值  3、设置最小值/最大值
access             允许从API文档中过滤参数。
allowMultiple      指定参数是否可以通过具有多个事件接受多个值，默认为false
example            单个示例
examples         参数示例。仅适用于BodyParameters

示例：

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
@ApiImplicitParams({
      @ApiImplicitParam(name = "name", value = "用户名", required = false, paramType = "query", dataType = "String"),
      @ApiImplicitParam(name = "pass", value = "密码", required = false, paramType = "query", dataType = "String") 
})
public UserModel login(@RequestParam(value = "name", required = false) String account,
                @RequestParam(value = "pass", required = false) String password){}

四、@ApiModel

用在请求的类上，表示对类的说明

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

@ApiModelProperty：用在属性上，描述响应类的属性

常用参数：

value                  此属性的简要说明。
name                     允许覆盖属性名称
其他参数：

allowableValues          限制参数的可接受值。1.以逗号分隔的列表   2、范围值  3、设置最小值/最大值
access             允许从API文档中过滤属性。
notes              目前尚未使用。
dataType            参数的数据类型。可以是类名或者参数名，会覆盖类的属性名称。
required            参数是否必传，默认为false
position            允许在类中对属性进行排序。默认为0
hidden             允许在Swagger模型定义中隐藏该属性。
example                属性的示例。
readOnly            将属性设定为只读。
reference           指定对相应类型定义的引用，覆盖指定的任何参数值

示例：

@ApiModel(value="用户登录信息", description="用于判断用户是否存在")
public class UserModel implements Serializable{
    private static final long serialVersionUID = 1L;

    /**用户名 */ 
    @ApiModelProperty(value="用户名") 
    private String account;

    /**密码 */ 
    @ApiModelProperty(value="密码") 
    private String password;
}

五、@ApiResponses

用在请求的方法上，表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

常用参数：

code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类

示例：

@ResponseBody
@PostMapping(value="/update/{id}")
@ApiOperation(value = "修改用户信息",notes = "打开页面并修改指定用户信息")
@ApiResponses({
    @ApiResponse(code=400,message="请求参数没填好"),
    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})
public JsonResult update(@PathVariable String id, UserModel model){}

六、@ApiParam

用在请求方法中，描述参数信息

常用参数：

name：参数名称，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
value：参数的简要说明。
defaultValue：参数默认值
required           属性是否必填，默认为false [路径参数必须填]
其他参数：

allowableValues    限制参数的可接受值。1.以逗号分隔的列表   2、范围值  3、设置最小值/最大值
access             允许从API文档中过滤参数。
allowMultiple      指定参数是否可以通过具有多个事件接受多个值，默认为false
hidden             隐藏参数列表中的参数。
example            单个示例
examples         参数示例。仅适用于BodyParameters

示例：

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@ApiParam(name = "name", value = "用户名", required = false) @RequestParam(value = "name", required = false) String account,@ApiParam(name = "pass", value = "密码", required = false) @RequestParam(value = "pass", required = false) String password){}

//或以实体类为参数：
@ResponseBody @PostMapping(value="/login") @ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在") public UserModel login(@ApiParam(name = "model", value = "用户信息Model") UserModel model){}