首页  思维导图  详情

rest

2023-08-25 06:23:08   3  举报





AI智能生成

为你推荐

查看更多



REST: servicios uniformes

REST API接口交互安全设计

REST: Objetivos

rest 应用

java

java web

REST

RestTemplate

作者其他创作

大纲/内容

REST表示 Representational State Transfer（表现层状态转换)

它是可以用来设计web services的框架，可以被不同的客户端调用。

REST是一种架构风格，其核心是面向资源，REST专门针对网络应用设计和开发方式，以降低开发的复杂性，提高系统的可伸缩性。

RESTful是对http最全面最好的诠释，RESTful就是进行互联网开发的理念、思想

说明

1.网络上的所有事物都可以被抽象为资源(resource)

2.每一个资源都有唯一的资源标识(resource identifier)－URI，对资源的操作不会改变这些标识

3.所有的操作都是无状态的

REST提出设计概念和准则

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。

因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。

概述

API与用户的通信协议，总是使用HTTPs协议。

1.协议

https://api.example.com

应该尽量将API部署在专用域名之下。

https://example.org/api/

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

2.域名

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

应该将API的版本号放入URL。

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

3.版本（Versioning）

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，13;而且所用的名词往往与数据库的表格名对应。13;一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

4.路径（Endpoint）

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

GET（SELECT）：从服务器取出资源（一项或多项）。

POST（CREATE）：在服务器新建一个资源。

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

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

DELETE（DELETE）：从服务器删除资源。

常用的HTTP动词

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：删除某个指定动物园的指定动物

动词举例

5.HTTP动词

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

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

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

?page=2&per_page=100：指定第几页，以及每页的记录数。

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

?animal_type_id=1：指定筛选条件

常见的参数

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。13;比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

6.过滤信息（Filtering）

服务器向用户返回的状态码和提示信息

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

常见的状态码

7.状态码（Status Codes）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

eg: { error: "Invalid API key" }

8.错误处理（Error handling）

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

GET /collection：返回资源对象的列表（数组）

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

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

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

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

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

9.返回结果

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

10.Hypermedia API

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

11.其他

RESTful API 设计指南

尽管没有限制必须返回的类型，但是一般基于Web services的Rest返回JSON或者XML作为响应。

客户端可以指定（使用HTTP Accept header）他们想要的资源类型吗，服务器返回需要的资源。13;指明资源的Content-Type。

返回数据类型

GET 方式请求 /api/user/ 返回用户列表

GET 方式请求 /api/user/1返回id为1的用户

POST 方式请求 /api/user/ 通过user对象的JSON 参数创建新的user对象

PUT 方式请求 /api/user/3 更新id为3的发送json格式的用户对象

DELETE 方式请求/api/user/4删除 ID为 4的user对象

DELETE 方式请求/api/user/删除所有user

REST API

<dependency>\t<groupId>com.fasterxml.jackson.core</groupId>\t<artifactId>jackson-databind</artifactId>\t<version>2.8.6</version></dependency>

json转换器

<dependency>\t <groupId>commons-fileupload</groupId>\t <artifactId>commons-fileupload</artifactId>\t <version>1.3.2</version></dependency>

文件上传

POM依赖配置

<bean id="multipartResolver"\t\t class="org.springframework.web.multipart.commons.CommonsMultipartResolver">\t\t<property name="defaultEncoding" value="utf-8"/>\t\t<property name="maxInMemorySize" value="20480"/>\t\t<property name="maxUploadSize" value="2097152000"/>\t\t<property name="maxUploadSizePerFile" value="20971520"/>\t</bean>

spring配置文件上传

开发环境配置

@Controller 和 @ResponseBody的结合体。

它实际就是@Controller和@ResponseBody混合使用的简写方法。

@RestController

如果方法参数被 @RequestBody注解，Spring将绑定HTTP请求体到那个参数上。

如果那样做，Spring将根据请求中的ACCEPT或者 Content-Type header（私下）使用 HTTP Message converters 来将http请求体转化为domain对象。

@RequestBody

如果方法加上了@ResponseBody注解，Spring返回值到响应体。如果这样做的话，Spring将根据请求中的 Content-Type header（私下）使用 HTTP Message converters 来将domain对象转换为响应体。

@ResponseBody的作用是将返回的对象放入响应消息体中

@ResponseBody

是一个真实数据.它代表了整个 HTTP 响应（response）. 它的好处是你可以控制任何对象放到它内部。