springboot使用swagger3生成接口文档，最新UI界面

最新推荐文章于 2025-03-18 14:07:34 发布

北方的文先生

最新推荐文章于 2025-03-18 14:07:34 发布

阅读量2.5k

点赞数 1

本文链接：https://blog.youkuaiyun.com/Lean_on_Me/article/details/128043257

版权

本文介绍了如何在SpringBoot项目中使用Swagger3生成接口文档，包括常用的Swagger注解如@Api、@ApiModel、@ApiModelProperty等，并展示了如何添加Swagger3依赖，启用@EnableOpenApi注解，以及使用新的UI界面knife4j-spring-boot-starter。

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

swagger常用注解

@Api 标识一个java类型是文档类，用controller类的类名上

@ApiModel 表示一个实体类/模型文档，用在类名上；

@ApiModelProperty 作用在属性上，添加属性描述；

@ApiOperation 作用在接口类的方法上，控制方法的相关描述；

@ApiImplicitParam 作用在接口方法上，描述单个参数信息，只能作用在方法上；

@ApiImplicitParams 作用在接口方法上，@ApiImplicitParam参数组；

@ApiParam 作用在接口方法上，描述单个参数信息，属性基本与@ApiImplicitParam一样，但可以作用在方法、参数、属性上；

在项目的pom文件中加入Swagger3依赖

    <!--Swagger3-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactI

最低0.47元/天解锁文章