【Swagger2】【3】API注解详解，以及注解常用参数配置

最新推荐文章于 2025-09-29 10:45:41 发布

转载最新推荐文章于 2025-09-29 10:45:41 发布 · 1.1k 阅读

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/huashengweilong/p/11379908.html

本文深入解析Swagger API注解的使用方法，包括@ApiOperation、@ApiImplicitParam、@ApiModelProperty等，详细介绍其参数配置及在Controller层的具体应用，帮助开发者快速掌握并运用到项目中。

前言：

@Api，@ApiOperation，@ApiImplicitParam，@ApiModelProperty

正文：

1，Controller层

@CrossOrigin(origins = "*")
@RestController
@Api(tags = {"文章接口"})
public class ArticleController {
    @ApiOperation(value = "文章详情")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "文章编号", required = true, dataType = "String", paramType = "query"),
    })
    @RequestMapping(value = "article", method = RequestMethod.GET)
    public Result<Article> getArticleInfo(String id) {
        return this.theService.getArticleInfo(id);
    }
}

@Api：作用在类上，用来标注该类具体实现内容。

参数：

1，tags：该类的名称
2，description：描述该类的作用

@ApiOperation：表示一个http请求的操作

参数：

1，value ：接口名称

@ApiImplicitParam：接口的单个请求参数

参数：

1，name ：参数名
2，value ：描述参数名
3，required ：该参数是否必填
4，dataType ：参数的数据类型
5， paramType ：查询参数类型，可不填。这里有几种形式：

类型	作用
path	以地址的形式提交数据
query	直接跟参数完成自动映射赋值
body	以流的形式提交仅支持POST
header	参数在request headers 里边提交
form	以form表单的形式提交仅支持POST

2，如果传入的参数是用实体类接收的

public class AddVo {
    @ApiModelProperty(name="province", value="所在省", required=true)
    private String province;

    @ApiModelProperty(name="city", value="所在市", required=true)
    private String city;
}

@ApiModelProperty：同@ApiImplicitParam一致

参考博客：

SwaggerAPI注解详解,以及注解常用参数配置 - 都让你们叫老了的博客 - 优快云博客
https://blog.youkuaiyun.com/java_yes/article/details/79183804

转载于:https://www.cnblogs.com/huashengweilong/p/11379908.html