SpringbootApi接口学习笔记

事无巨细

已于 2022-02-23 18:26:49 修改

阅读量1.3k

点赞数 4

文章标签： java api spring boot

于 2022-02-23 14:48:08 首次发布

本文链接：https://blog.csdn.net/jj123kill/article/details/123089958

版权

本文详细介绍了如何在SpringBoot中设置API接口的返回格式，包括类注解@RestController和方法注解@ResponseBody的应用。此外，讲解了不同请求方式如@GetMapping、@PostMapping等的使用，以及@RequestParam和@PathVariable参数处理技巧。

摘要由CSDN通过智能技术生成

SpringBootApi接口

前言：

网络程序正朝着移动设备的方向发展，前后端分离、APP，最好的交互交互方式莫过于通过API接口实现。

为了方便测试，我们利用swagger3将接口文档

1.返回格式

Api接口要求的返回的格式是application/json,网页默认格式为text/html,springboot为实现api接口，提供了两种实现方式，

类注解：@RestController

在写Controller文件的时候，在类前加上注解*@RestController*，返回的格式就是text/json
方法注解：@ResponseBody

在Controller文件中在需要定义成api接口的方法中，该方法返回的数据就是text/json

**注意：**一般使用的都是类注解，是代码风格统一

2.请求方式

@RequestMapping：支持任意请求方式

@GetMapping：客户端只能用 GET 方式请求，适用于查询数据

@PostMapping：客户端只能用 POST方式请求，适用于提交数据

@DeleteMapping：客户端只能用 DELETE方式请求，使用于删除数据。

@PutMapping：客户端只能用 PUT方式请求，使用于修改数据

3.接收参数

@RequestParam：一般参数接受

@RequestParam
public String getInfo(@RequestParam(name = "param",required = false,defaultValue = "param dafault value") String param)

name代表提交参数名。
required意思是这个参数是否必需，默认true，没有该参数，无法调用此方法；这里设为false，有无该参数都可以调用。
defaultValue如果该参数值为空，那么就使用默认值。

@PathVariable：
```
@RequestMapping("/get-info/{param}")
public String getInfo(@PathVariable("param") Object param)
```
我们可以在请求方法后面直接跟值，省去了 ？参数名= 。这种一般配合 @DeleteMapping、@PutMapping使用。
@RequestHeader

这个使用了获取提交数据的 Headers 的值。可以用来接收 TOKEN。
```
@RequestHeader("token")!
```