SpringBootのRestfulのAPIスタイルの開発+ SpringBoot統合闊歩
githubのソース:https://github.com/xivinChen/SpringBoot
.RestfulスタイルのAPI
禁止された名前の安らかなAPIの動詞は、すなわち動作モードの要求を区別します。次のとおりです。
get 查询接口 post 新增接口 put 更新接口 delete 删除接口
モジュールspringboot-安らか-API 1.maven-原型・クイックスタートモードを作成します。
2.コピーしたコードおよび構成モジュールspringboot-SSMは、追加の依存関係が導入されません。
インタフェース繧に3.変更UserControllerでコード
@RestController
@RequestMapping("/user")
public class UserController {
@Resource
private UserMapper userMapper;
//@RequestMapping("/listByUser")
@GetMapping("/")
public List<User> 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 /ユーザー / 1
5.安らかなスタイルのAPIを導入した後、ポストは、優れた操作ではありませんブラウザで私たちは私たちのポストマン・テストを支援するテストツールをダウンロードするかを選択することができ、この時間を削除要求を置きます。しかしSpringBootは、あなたが簡単にインターフェイスをテストすることができ、非常に強力なテストツールを統合することができます。それは伝説の闊歩です
二.SpringBoot統合闊歩
1.依存紹介
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
コンフィギュレーション・クラスSwaggerConfig.javaを作成します。2.
.apisパケット制御部に相当する(RequestHandlerSelectors.basePackage( "xyz.java1024.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)注解来隐藏属性
パブリッククラスユーザーは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 restful api开发,同时集成swagger测试接口!