3.配置Swagger2

本文介绍了如何将Postman替换为Swagger2进行接口测试。首先,导入Swagger2的两个依赖,然后创建SwaggerConfig配置类并启用Swagger2。通过访问端口加swagger-ui.html可以打开界面。对于更复杂的配置,可以通过在实体类和属性上添加注解进行详细说明。不进行复杂配置时,可以直接在Swagger界面上选择接口进行测试。

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

集成Swagger

原来需要用postman来测试接口,现在我们使用Swagger2

(一)导入两个依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>


<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>


(二)配置Swagger2

1.写一个config配置包
在这里插入图片描述
2.在SwaggerConfig中配置

package com.gy.springcloud.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration  //表明这是一个配置类
@EnableSwagger2 //开启Swagger
public class SwaggerConfig {
}

其实配置两个注解我们就可以简单的使用了

(三)访问

端口号+swagger-ui.html 就可以访问

在这里插入图片描述

(四)更复杂的配置Swagger

1.在返回的类中使用注解给实体类进行注释

package com.gy.springcloud.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

//这个类是用来传给前端的

@ApiModel("实体类")
public class CommonResult <T>{  
    private Integer code;
    @ApiModelProperty("异常信息")
    private String massage; 

    @ApiModelProperty("数据")
    private T  data;

@ApiModel("")里面写类的注释信息
@ApiModelProperty(“”)里面写属性的注释信息

在这里插入图片描述

(五)其实不复杂配置也行,直接用

1.找到你的接口点开
在这里插入图片描述
2.点击你想要检验的请求
在这里插入图片描述
3.点这里
在这里插入图片描述

4.输入数据,提交
在这里插入图片描述
5.查看结果
在这里插入图片描述
6.查看数据库结果
在这里插入图片描述
当然这里的ID有点问题是因为我设置id自动加的

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值