bcb6通过https接口post数据_SpringBoot快速开发RESTful接口

本节主要学习springboot + restful进行接口开发。

1.RESTful架构

1.1 理解RESTful

网站即软件，REST全称Representational State Transfer，翻译：表现层状态转化

一个架构符合REST原则，就称它为RESTful架构

REST的名称"表现层状态转化"中，省略了主语。"表现层"其实指的是"资源"(Resources)的"表现层"

所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息；

互联网上资源(是服务)细化理解为一个url，如果访问某个资源通过http url访问。

我们把”资源”具体呈现出来的形式，叫做它的”表现层”(Representation)

表现层对用户展示的形式：html、json、xml、pdf、图片。

互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源(也可以用于更新资源)，PUT用来更新资源，DELETE用来删除资源。

总结一句话：在URI中标识资源访问状态。

1.2 RESTful特点

1.每一个URI代表一种资源；

2.客户端和服务器之间，传递这种资源的某种表现层；

3.客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"

1.3 RESTful设计原则

协议：API与用户的通信协议，总是使用http或https协议

域名：应该尽量将API部署在专用域名之下，举例：https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下：https://exa

mple.org/api/

版本：应该将API的版本号放入URL,举例：https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。

Github采用这种做法。

路径：路径又称"终点"(endpoint)，表示API的具体网址

在RESTful架构中，每个网址代表一种资源(resource),使用名词，不能使用动词；

所用的名词往往与数据库的表名对应数据库中的表都是同种记录的"集合"(collection)，所以API中的名词也应该使用复数

举例如下：

https://api.example.com/v1/users

https://api.example.com/v1/companys

http动词：对于资源的具体操作类型，由HTTP动词表示

常用的HTTP动词有下面五个(括号里是对应的SQL命令):

GET(SELECT)：从服务器取出资源(一项或多项)

POST(CREATE)：在服务器新建一个资源

PUT(UPDATE)：在服务器更新资源(客户端提供改变后的完整资源)

PATCH(UPDATE)：在服务器更新资源(客户端提供改变的属性)

DELETE(DELETE)：从服务器删除资源

还有两个不常用的HTTP动词:

HEAD：获取资源的元数据

OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的

举例如下：

GET /zoos：列出所有动物园

POST /zoos：新建一个动物园

GET /zoos/ID：获取某个指定动物园的信息

PUT /zoos/ID：更新某个指定动物园的信息(提供该动物园的全部信息)

PATCH /zoos/ID：更新某个指定动物园的信息(提供该动物园的部分信息)

DELETE /zoos/ID：删除某个动物园

GET /zoos/ID/animals：列出某个指定动物园的所有动物

DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

过滤信息：如果记录数量很多，服务器不可能都将它们返回给用户

API应该提供参数，过滤返回结果,下面是一些常见的参数

?limit=10：指定返回记录的数量

?offset=10：指定返回记录的开始位置

?pageNum=2&pageSize=100：指定第几页，以及每页的记录数

?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。

?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。

比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的

状态码：服务器向用户返回的状态码和提示信息，常见如下(方括号中是该状态码对应的

HTTP动词)：

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的(Idempotent)

201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功

202 Accepted - [*]：表示一个请求已经进入后台排队(异步任务)

204 NO CONTENT - [DELETE]：用户删除数据成功

400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器

没有进行新建或修改数据的操作，该操作是幂等的

401 Unauthorized - [*]：表示用户没有权限(令牌、用户名、密码错误)

403 Forbidden - [*] 表示用户得到授权(与401错误相对)，但是访问是被禁止的

404 NOT FOUND - [*]：用户发出请求针对不存在的记录，服务器无法操作，该

操作是幂等的

406 Not Acceptable - [GET]：用户请求格式错误(比如请求JSON格式,但是只有

XML格式)

410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的

422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验

证错误

500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的

请求是否成功

错误处理：如果状态码是4xx，就应该向用户返回出错信息

一般来说，返回的信息中将error作为键名，出错信息作为键值即可

{ error: "Invalid API key" }

返回结果：针对不同操作，服务器向用户返回的结果应该符合以下规范：

GET /collection：返回资源对象的列表(数组)

GET /collection/resource：返回单个资源对象

POST /collection：返回新生成的资源对象

PUT /collection/resource：返回完整的资源对象

PATCH /collection/resource：返回完整的资源对象

DELETE /collection/resource：返回一个空文档

Hypermedia API：

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法使得用户不查文档，也知道下一步应该做什么。{"link": {"rel": "collection https://www.example.com/zoos","href": "https://api.example.com/zoos","title": "List of zoos","type": "application/vnd.yourformat+json"}}上面代码文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了rel表示这个API与当前网址的关系(collection关系，并给出该collection的网址)href表示API的路径，title表示API的标题，type表示返回类型Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表: {"current_user_url": "https://api.github.com/user","authorizations_url": "https://api.github.com/authorizations",// ...}从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user然后就得到了下面结果: {"message": "Requires authentication","documentation_url": "https://developer.github.com/v3" }上面代码表示，服务器给出了提示信息，以及文档的网址2

其他事项：

(1). API的身份认证应该使用OAuth 2.0框架

(2). 服务器返回的数据格式，应该尽量使用JSON，避免使用XML

2.RESTful案例

2.1 创建springboot项目

创建springboot-restful项目，勾选以下选项：

本次案例的接口开发是基于springboot + mybatis整合案例，具体的坐标配置，数据库配置，编写实体类，编写持久化层代码，编写服务层代码请参考我的学习笔记《SpringBoot集成Mybatis》案例。

2.2 编写基于RESTful接口控制器代码

package raky.train.controller;import org.springframework.web.bind.annotation.*;import raky.train.entity.User;import raky.train.service.UserService;import javax.annotation.Resource;import java.util.List;/** * 符合restful风格的控制器 *   1.协议 ==> http/https *   2.资源 ==> 名词，复数 *   3.状态 ==> http协议中的状态 *      GET ==> getOne()/getList()/getPage() ==> select * from table... *      POST ==> insert() ==> insert into ... *      PUT ==> update() ==> update table ... (完整资源 ==> 修改用户信息) *      PATCH ==> update()  ==> update table ... (部分资源  ==> 密码重置) *      DELETE ==> delete() ==> delete from ... * *   RESTFUL 全称：表现层状态转换 *      表现层  ==> 资源[名词] ==> URL地址 *      状态   ==> 表现层提交/请求方式[动词] ==> http [get/post/put/patch/delete] *      转化   ==> 客户端携带资源 + 提交方式  ==> 服务器端接收转化动作 * */@RestController@RequestMapping("/users")public class UserController {    @Resource    private UserService userService;    @PostMapping    public int insert(@RequestBody User user){        return userService.insert(user);    }    @PutMapping    public int update(@RequestBody User user){        return userService.update(user);    }    @PatchMapping    public int update(Integer id, String pass){        return userService.update(User.builder().id(id).pass(pass).build());    }    @DeleteMapping(value="/{id}")    public int delete(@PathVariable(value = "id",required = true) Integer id){        return userService.delete(id);    }    @GetMapping(value="/{id}")    public User getOne(@PathVariable(value = "id",required = true) Integer id){        return userService.getOne(id);    }    @GetMapping("")    public List getList(User user){        return userService.getList(user);    }}

2.2 调试运行接口

案例调试使用postman工具进行接口测试。

添加接口测试如下：

修改接口(提供完整参数)测试如下：

修改接口(提供部分参数)测试如下：

删除接口测试如下：

获取单个数据接口测试如下：

获取列表数据接口测试如下:

至此，SpringBoot快速开发RESTful接口的案例学习笔记整理完毕。如果对大家有帮助，整理不易，希望多点赞，多收藏和多转发，在此表示感谢。每天进步一点点，多实践多总结，越分享越快乐。有技术问题，欢迎大家沟通交流，或者在评论区留言。