Springboot 整合Swagger 2框架 让接口查看及调试更加优雅

//不需要时，或者生产环境可以在此处关闭

.enable(true);

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("JCccc springboot整合Swagger2项目 ")

.description(“描述：测试使用Swagger2！”)

//服务条款网址

.termsOfServiceUrl(“https://blog.csdn.net/qq_35387940”)

.contact(“JCccc”)

.version(“1.0”)

.build();

}

}

然后是写一个Controller ，整合Swagger2框架注解 Swagger2TestController.java：

import com.alibaba.fastjson.JSONObject;

import com.soelegant.elegantdemo.pojo.UserInfo;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.*;

/**

• @Author：JCccc

• @Description：

• @Date： created in 20:54 2019/5/25

*/

@Api(value = “测试各种方法”, tags = {“测试使用Controller”})

@RestController

public class Swagger2TestController {

@ApiOperation(value = “测试Swagger2接口”, notes = “传入编号！”)

@ApiImplicitParam(name = “id”, value = “id”, required = true)

@RequestMapping(value = “/swaTest2/{id}”, method = RequestMethod.GET)

public String TestSwa2(@PathVariable(“id”) Integer id) {

System.out.println(“swaTest！”);

// Optional user = userRepository.findById(id);

UserInfo userInfo = new UserInfo();

userInfo.setUsername(“test”);

userInfo.setState(1);

userInfo.setPassword(“123456”);

userInfo.setNickName(“testNickName”);

userInfo.setIsDeleted(id);

userInfo.setIds(null);

userInfo.setIdList(null);

return userInfo.toString();

}

@ApiOperation(value = “swaTest3”, notes = “测试GET！”)

@ApiImplicitParam(name = “name”, value = “用户name”)

@RequestMapping(value = “/swaTest3”, method = RequestMethod.GET)

public String TestSwa3(@RequestParam(“name”) String name) {

System.out.println(“swaTest！”);

return name;

}

@ApiOperation(value = “swaTest4”, notes = “测试POST！”)

@RequestMapping(value = “/swaTest4”, method = RequestMethod.POST)

public String TestSwa4(@RequestBody JSONObject jsonObject) {

System.out.println(“swaTest4！” + jsonObject.toString());

String str = jsonObject.toString();

return str;

}

@ApiOperation(value = “swaTest5”, notes = “测试对象传值！”)

@RequestMapping(value = “/swaTest5”, method = RequestMethod.POST)

public String TestSwa5(UserInfo userInfo) {

return userInfo.toString();

}

}

可以看到上面的第一个接口用到了UserInfo实体类， 那么我们也将这个跟接口有关的类也结合Swagger2注解  UserInfo.java：

import io.swagger.annotations.ApiModel;

import io.swagger.annotations.ApiModelProperty;

import lombok.Data;

import java.io.Serializable;

import java.util.List;

/**

• @Author：JCccc

• @Description：

• @Date： created in 20:57 2019/5/25

*/

@Data

@ApiModel(value = “userInfo 对象”,description = “用户对象user”)

public class UserInfo implements Serializable {

private static final long serialVersionUID = 1L;

@ApiModelProperty(value=“用户名”,name=“username”,example=“lx”)

private String username;

@ApiModelProperty(value=“状态”,name=“state”,required=true)

private Integer state;

private String password;

private String nickName;

private Integer isDeleted;

@ApiModelProperty(value=“id数组”,hidden=true)

private String[] ids;

private List idList;

}

那么到此，我们整合Swagger2基本已经完毕，接下来看看效果：

运行项目后，进入Swagger2的接口页面：http://localhost:8099/swagger-ui.html#      （端口就是自己项目的端口，我自己的是8099）

然后可以点开接口看看，顺便还可以在线调试（点开接口，点击Try it out）：

然后/swaTest4这个接口是通过@RequestBody JSONObject jsonObject 接收参数，所以在Swagger2的接口页面上，我们也传入一个json格式数据：

{

“userName”: “testName”,

“userId”:“22222222”

}

如图：

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

面试结束复盘查漏补缺

每次面试都是检验自己知识与技术实力的一次机会，面试结束后建议大家及时总结复盘，查漏补缺，然后有针对性地进行学习，既能提高下一场面试的成功概率，还能增加自己的技术知识栈储备，可谓是一举两得。

以下最新总结的阿里P6资深Java必考题范围和答案，包含最全MySQL、Redis、Java并发编程等等面试题和答案，用于参考~

重要的事说三遍，关注+关注+关注！

更多笔记分享

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
包含最全MySQL、Redis、Java并发编程等等面试题和答案，用于参考~

重要的事说三遍，关注+关注+关注！

[外链图片转存中…(img-Q5UKS8XI-1713400937738)]

[外链图片转存中…(img-WAmoDcwk-1713400937739)]

更多笔记分享

[外链图片转存中…(img-WNb5JAzE-1713400937739)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！