SpringBoot在整合swagger2中常用注解，更方便的使用和阅读文档

最新推荐文章于 2022-06-30 21:19:56 发布

木偶彡

最新推荐文章于 2022-06-30 21:19:56 发布

阅读量249

点赞数

分类专栏： Spring 微服务文章标签： java

本文链接：https://blog.youkuaiyun.com/oWangXiaoPeng/article/details/109334846

版权

微服务同时被 2 个专栏收录

14 篇文章

订阅专栏

Spring

8 篇文章

订阅专栏

本文详细介绍SpringBoot项目中如何集成Swagger2实现API文档自动生成。包括如何在控制器上使用@Api、@ApiOperation等注解来描述接口作用及请求方式，以及如何通过@ApiModel和@ApiModelProperty注解对接口参数进行描述。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot整合swagger2的方法请阅读

Spring boot 整合swagger2的步骤

一、controller上使用

@Api(value = "注册登陆",tags = {"用于登陆的相关接口"})

类名上的备注，主要用于展示整个类接口的分组描述。

@ApiIgnore

忽略生成api

@ApiOperation(value = "用户注册",notes = "用户注册",httpMethod = "POST")

方法上描述，该接口的左右及请求方式

@ApiModel(value = "用户注册对象",description = "客服端传来的数据封装")
@DATA
public class UserBO {
    @ApiModelProperty(value = "用户名",name="username",example = "admin",required = true)
    private String username;
    @ApiModelProperty(value = "密码",name="password",example = "123456",required = true)
    private String password;
    @ApiModelProperty(value = "确认密码",name="confirmPassword",example = "123456",required = true)
    private String confirmPassword;
}

接口参数封装类上的描述

整体效果：