接口上说明参数的swagger注解

Swagger可以通过注解的方式来描述API的请求参数。常用的注解包括：

- @Api：用于描述API的基本信息，包括名称、描述、版本等信息；
- @ApiOperation：用于描述API的操作，包括HTTP方法、URL、操作名称、操作描述等信息；
- @ApiParam：用于描述API的请求参数，包括参数名、数据类型、是否必填、默认值、描述等信息；
- @ApiImplicitParam：用于描述API的请求参数，包括参数名、数据类型、是否必填、默认值、描述等信息；
- @ApiImplicitParams：用于描述API的多个请求参数，可以包含多个@ApiImplicitParam注解；
- @ApiModel：用于描述API的请求或响应参数的数据模型，包括模型名、字段、描述等信息；
- @ApiModelProperty：用于描述API的请求或响应参数的数据模型的字段，包括字段名、数据类型、描述等信息。

例如，以下是一个使用Swagger注解的示例：

@RestController
@Api(tags = "用户管理")
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/{id}")
    @ApiOperation(value = "根据ID获取用户信息", notes = "根据用户ID获取用户信息")
    public User getUserById(@PathVariable Long id) {
        // ...
    }

    @PostMapping
    @ApiOperation(value = "创建用户", notes = "创建新用户")
    public User createUser(@ApiParam(name = "用户信息", value = "用户对象", required = true) @RequestBody User user) {
        // ...
    }
}

在上面的示例中，@Api注解描述了API的基本信息，@ApiOperation注解描述了API的操作信息，@ApiParam注解描述了请求参数的信息。这些注解可以帮助开发者更好地理解API的含义和用法，提高API的可读性和可维护性。