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

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

swagger常用注解

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

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

@ApiModelProperty 作用在属性上,添加属性描述;

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

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

@ApiImplicitParams 作用在接口方法上,@ApiImplicitParam参数组;

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

更多详细注解 请参考: (95条消息) swagger常用注解_十年(Sugar)的博客-CSDN博客_swagger注解

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

    <!--Swagger3-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactI
  • 1
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值