SpringBoot整合swagger实现测试Restful风格api-创新互联

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

成都创新互联公司是专业的道县网站建设公司，道县接单;提供网站设计、成都网站制作,网页设计,网站设计,建网站,PHP网站建设等专业做网站服务;采用PHP框架,可快速的进行道县网站开发网页制作和功能扩展;专业做搜索引擎喜爱的网站,专业的做网站团队,希望更多企业前来合作!

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

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

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?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

### 4.调用get请求接口 
![swagger-ui](https://img-blog.csdnimg.cn/20191218181652737.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

### 5.对于实体类型的请求参数体，我们在Controller接口加上@RequestBody 可读性会更加好！
> 修改前
![swagger-ui](https://img-blog.csdnimg.cn/20191218181712559.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

> 修改后
![swagger-ui](https://img-blog.csdnimg.cn/20191218181731871.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

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

> 重新启动刷新swagger-ui页面
![swagger-ui](https://img-blog.csdnimg.cn/201912181817490.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

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

![swagger-ui](https://img-blog.csdnimg.cn/20191218181804811.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

### 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?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTI1NDI1Mg==,size_16,color_FFFFFF,t_70)

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

另外有需要云服务器可以了解下创新互联scvps.cn，海内外云服务器15元起步，三天无理由+7*72小时售后在线，公司持有idc许可证，提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案，具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势，专为企业上云打造定制，能够满足用户丰富、多元化的应用场景需求。

新闻名称：SpringBoot整合swagger实现测试Restful风格api-创新互联
当前链接：http://6mz.cn/article/cdphgi.html

网站建设知识