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

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！

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

.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”

}

如图：

总结

就写到这了，也算是给这段时间的面试做一个总结，查漏补缺，祝自己好运吧，也希望正在求职或者打算跳槽的 程序员看到这个文章能有一点点帮助或收获，我就心满意足了。多思考，多问为什么。希望小伙伴们早点收到满意的offer! 越努力越幸运！

金九银十已经过了，就目前国内的面试模式来讲，在面试前积极的准备面试，复习整个 Java 知识体系将变得非常重要，可以很负责任的说一句，复习准备的是否充分，将直接影响你入职的成功率。但很多小伙伴却苦于没有合适的资料来回顾整个 Java 知识体系，或者有的小伙伴可能都不知道该从哪里开始复习。我偶然得到一份整理的资料，不论是从整个 Java 知识体系，还是从面试的角度来看，都是一份含技术量很高的资料。

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
va 知识体系将变得非常重要，可以很负责任的说一句，复习准备的是否充分，将直接影响你入职的成功率。但很多小伙伴却苦于没有合适的资料来回顾整个 Java 知识体系，或者有的小伙伴可能都不知道该从哪里开始复习。我偶然得到一份整理的资料，不论是从整个 Java 知识体系，还是从面试的角度来看，都是一份含技术量很高的资料。**

[外链图片转存中…(img-QFAUM3vM-1714664349278)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！