SpringBoot整合swagger实现测试Restful风格api

这篇文章运用了实例代码展示SpringBoot整合swagger实现测试Restful风格api的步骤，代码非常详细，可供感兴趣的小伙伴们参考借鉴，希望对大家有所帮助。

创新互联公司专注为客户提供全方位的互联网综合服务，包含不限于成都网站建设、网站建设、巴南网络推广、小程序定制开发、巴南网络营销、巴南企业策划、巴南品牌公关、搜索引擎seo、人物专访、企业宣传片、企业代运营等，从售前售中售后，我们都将竭诚为您服务，您的肯定，是我们最大的嘉奖；创新互联公司为所有大学生创业者提供巴南建站搭建服务，24小时服务热线：18980820575，官方网址：www.cdcxhl.com

一.Restful 风格API

restful API 命名禁止出现动词，即用请求方式区分动作。如下：

get 查询接口
post 新增接口
put 更新接口
delete 删除接口

1.maven-archetype-quickstart方式创建模块springboot-restful-api

2.把springboot-ssm模块的代码和配置复制过来,不需要额外引入依赖。

3.修改UserController代码，改成Restful接口

@RestController
@RequestMapping("/user")
public class UserController {

    @Resource
    private UserMapper userMapper;

    //@RequestMapping("/listByUser")
    @GetMapping("/")
    public List listByUser() {
        return userMapper.list();
    }

    //@RequestMapping("/getOneUser")
    @GetMapping("/{id}")
    public User getOneUser(@PathVariable("id") int id) {
        return userMapper.selectByPrimaryKey(id);
    }

    //@RequestMapping("/addUser")
    @PostMapping("/")
    public int addUser(User user) {
        return userMapper.insert(user);
    }

    //@RequestMapping("/deleteUser")
    @DeleteMapping("/{id}")
    public int deleteUser(@PathVariable("id") int id) {
        return userMapper.deleteByPrimaryKey(id);
    }

    @PutMapping("/")
    public int updateUser(User user) {
        return userMapper.updateByPrimaryKey(user);
    }
}

4.运行测试，浏览器 http://localhost:8090/user/1

5.引入restful 风格api后，post put delete请求方式在浏览器就不好操作了，此时我们可以选择下载一个测试工具Postman来辅助我们测试。但SpringBoot可以集成一个很强大的测试工具，可以很方便的测试接口。它就是传说中的Swagger

二.SpringBoot 集成Swagger

1.引入依赖

      io.springfox
      springfox-swagger2
      2.9.2
    
    
      io.springfox
      springfox-swagger-ui
      2.9.2
    

2.创建配置类SwaggerConfig.java

.apis(RequestHandlerSelectors.basePackage("xyz.java1024.controller")) 对应controller所处的包

### 3.浏览器进入api页面 地址为：http://localhost:8090/swagger-ui.html
![swagger-ui](https://img-blog.csdnimg.cn/20191218181626864.png)

### 5.对于实体类型的请求参数体，我们在Controller接口加上@RequestBody 可读性会更加好！
> 修改前
![swagger-ui](https://img-blog.csdnimg.cn/20191218181712559.png)

//@RequestMapping("/addUser")
@PostMapping("/")
public int addUser(@RequestBody User user) {
    return userMapper.insert(user);
}

> 重新启动刷新swagger-ui页面
![swagger-ui](https://img-blog.csdnimg.cn/201912181817490.png)

### 5.测试post请求
> 把创建时间和更新时间参数去掉 ,填写用户名等参数，成功插入一条数据。

![swagger-ui](https://img-blog.csdnimg.cn/20191218181804811.png)

### 6.swagger 增强
> 对于实体的某些属性我们时不需要传的，并且我们不想它显示在swagger的请求体中，如 新增用户的 createdAt和updatedAt 等属性，我们可以通过在属性上面添加@ApiModelProperty(hidden = true)注解来隐藏属性

public class User implements Serializable {
private int id;
private String username;

private String tel;

private String password;

private int status;

@ApiModelProperty(hidden = true)
private Timestamp createdAt;

@ApiModelProperty(hidden = true)
private Timestamp updatedAt;

> 此时重启刷新swagger页面，再次进入UserController的post可看到少了参数，如图参数变得相当简洁！
![swagger-ui](https://img-blog.csdnimg.cn/20191218181914671.png)

以上就是SpringBoot整合swagger实现测试Restful风格api的方法介绍，详细使用情况还得要大家自己使用过才能知道具体要领。如果想阅读更多相关内容的文章，欢迎关注创新互联行业资讯频道！

分享文章：SpringBoot整合swagger实现测试Restful风格api
标题链接：http://mswzjz.cn/article/gsehpc.html