Swagger2升级为knife4j,还是挺香的

先看一下升级前后的UI对比,反正我是喜新厌旧了,knife4j不但UI更加好看,还加入了接口统计图,各种请求方式的接口进行了统计,并且添加了接口搜索功能,项目中接口很多,使用swagger的时候需要一个一个找,太痛苦了。。。。

升级前
升级后

升级步骤

第一步:替换依赖

删除或者注释掉原来swagger的依赖:

 <!--整合Swagger时使用-->
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.9.2</version>
 </dependency>
 <!--整合Swagger时使用-->
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.9.2</version>
 </dependency>

引入knife4j 的依赖:

<!-- knife4j -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.2</version>
</dependency>
第二步:在swagger的配置类上添加@EnableKnife4j注解

在这里插入图片描述

重启项目,访问接口文档

注意:swagger2升级knife4j 后访问地址变了。

swagger接口文档地址:http://localhost:8080/swagger-ui.html
knife4j接口文档地址: http://localhost:8080/doc.html
第三步:请求参数文档和响应参数文档
// 接口说明的注解 @ApiOperation
@ApiOperation("查询队伍详情接口")
@GetMapping("/queryYjTeam")
// 生成请求参数文档的注解@ApiImplicitParam
@ApiImplicitParam(name = "teamId",value = "队伍ID",required = true)
// 生成响应参数文档的注解@ApiResponses
@ApiResponses({
        @ApiResponse(code = 200,message = "ok",response = YjTeamVo.class)
})
public Result queryYjTeams(String teamId){
        return yjTeamService.queryYjTeam(teamId);
}

YjTeamVo响应参数封装实体:

@Data
@Table(name = "T_YJ_TEAM")
@ApiModel(value = "队伍实体",description = "存储队伍信息")
public class YjTeamVo implements Serializable {
    private static final long serialVersionUID = -7873387444935908357L;
    @Id
    @ApiModelProperty(value = "队伍ID",required = false)
    private String teamId;
    @ApiModelProperty(value = "队伍名称",required = true)
    private String teamName;
    @ApiModelProperty(value = "队伍头像图",required = true)
    private String teamHeadPicture;
    }

在这里插入图片描述

  • 2
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值