企业🤖AI Agent构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
因为这次开发要遵循restful进行开发,所以在学习http的各种请求时,插入对restful知识的学习。哎~生命不息。学习不止啊~ 累且坚强啊~ 废话不多说进入正题... ... **安全方法**是指不修改资源的HTTP方法,更准备的说法是其不改变资源表示形式的HTTP方法。但是仍然可能改变服务器上的内容或资源,但这必须导致有不同的表现形式。 | 方法 | 安全性 | | --- | --- | | get | yes | | put | no | | post | no | | delete | no| | head| yes | | patch| yes | | options| yes | 详细解释: **GET**:用于获取一个具体的资源或者一个资源列表 **POST**:创建一个新的资源 **PUT**:以整体的方式更新服务器上的一个资源(客户端提供改变后的完整资源) **PATCH**:只更新服务器上的一个资源的一个属性(客户端提供改变的属性) **DELETE**:删除一个资源 **HEAD**:获取一个资源的元数据,例如,指向了解一个资源文件的大小、修改日期等; **OPTIONS**:用于获取资源支持的所有http方法(获取信息,关于资源的哪些属性是客户端可以改变的) ***** ## **restful与前端** RESTful 是一种遵守 REST 设计的架构风格。REST 既不是标准,也不是协议,而是一组架构约束条件和设计指导原则,一种基于HTTP、URI、XML 等现有协议与标准的开发方式。 ### **一、REST** REST它是 Representational State Transfer的缩写,表示**表述性状态转移**, “表述性”:是“资源”的“表述性” * **资源**:REST是面向资源的,资源是网络上的一个实体,可以是一个文件、一张图像、一首歌曲、甚至是一种服务。资源可以设计得很抽象,但只要是具体信息,就可以是资源,因为资源的本质是**一串二进制数据**。并且每个资源必须有URL,通过URL来找到资源。 * **表述**:资源在某个特定时刻的状态说明被称为表述(representation),表述由数据和描述数据的元数据(例如HTTP报文)组成。资源的表述有多种格式,这些格式也被称为MIME类型,例如文本的txt格式、图像的png格式、视频的mk格式等。一个资源可以有多种表述,例如服务器响应一个请求返回的资源可以是JSON格式的数据,也可以是XML格式的数据。 * **表述性状态转移**:表述性状态转移的目的是操作资源,通过转移和控制资源的表述就能实现此目的。例如客户端可以向服务器发送GET请求,服务器将资源的表述转移到客户端;客户端也可以向服务器发送POST请求,传递表述改变服务器中的资源状态。 ### **二、约束条件** REST给出了6种约束条件,通信两端在遵循这些约束后,就能提高工作效率,改善系统的**可伸缩性**、**可靠性**和**交互的可见性**,还能**促进服务解耦**。 **客户端-服务器**:客户端与服务器分离关注点,客户端关注用户接口,服务器关注数据存储客户端向服务器发起接口请求(获取数据或提交数据),服务器返回处理好的结果给客户端,客户端再根据这些数据渲染界面,同一个接口可以应用于多个终端(例如Web、iOs或 Android)大大改善了接口的可移植性,并且只要接口定义不变,客户端和服务器可以独立开发、互不影响。 **无状态**:两端通信必须是无状态的,服务器不会保存上一次请求的会话状态,会话状态要全部保存在客户端,从客户端到服务器的每个请求都要附带一些用于理解该请求的信息,例如在后台管理系中,大部分都是需要身份认证的请求,所以都会附带用户登录状态。 **缓存**:响应的资源可以被标记为可缓存或禁止缓存,如果可以缓存,那么客户端可以减少与服务器通信的次数,降低延迟、提高效率。 **统一接口**:统一接口是REST区别于其他架构风格的核心特征,接口定义包括4个部分 1. 资源的识别(identification of resources)也就是用一个URL指向资源,要获取这个资源,只要访问它的URL即可,URL就是资源的地址或标识符。REST对URL的命名也有要求,**在URL中不能有动词,只能由名词组成**。 2. 通过表述对资源执行操作(manipulation of resources through representations)在表述中包含了操作该资源的指令,例如用HTTP的请求首部 n/firb4, l kn http airhs accept tw&it, HTTP hiit(tn get,指定需要的表述格式,用HTTP方法(如get、POST等)完成对数据的增删改查工作,用HTTP响应状态码表示请求结果。 3. 自描述的消息(self-deive messages)包含如何处理该消息的信息,例如消息所使用的表述格式、能否被缓存等。 4. 作为应用状态引擎的超媒体(hypermedia as the engine of application state)超媒体并不是一种技术,而是一种策略,建立一种客户端与服务器之间的对话方式。超媒体可以将资源互相连接,并能描述它们的能力,告诉客户端如何构建HTTP请求。 **分层系统:**将架构分解为若干层,降低层之间的耦合性。每个层只能和与它相邻的层进行通信。 **按需代码:**这是一条可选的约束,支持客户端下载并执行一些代码(例如 Java AppletJava或 Flash)进行功能扩展。 ### **三、设计 RESTful API需要考虑的几个方面** 1. 通信用HTPS安全协议。 2. 在URL中加入版本号,例如“vl/animals's 3. URL中的路径(endpoint)不能有动词,只能用名词。 4. 用HTTP方法对资源进行增删改查的操作。 5. 用HTTP状态码传达执行结果和失败原因。 6. 为集合提供过滤、排序、分页等功能。 7. 用查询字符串或HTTP首部 (7)AifF*f* HTTP # accpet i1tw#t,ti& pETiT.进行内容协商,指定返回结果的数据格式。 8. 及时更新文档,每个接口都有对应的说明。 ``` ### 请求方式的举例: * 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:删除某个指定动物园的指定动物 ``` ``` ### 一些状态码: * 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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功 ``` ### **四、传统接口写法与Restful API区别** * [ ] 一个文件操作接口,传统模式: * api/getfile.php - 获取文件信息,下载文件 * api/uploadfile.php - 上传创建文件 * api/deletefile.php - 删除文件 * [ ] RESTfu,api/file 只需要这一个接口: * GET 方式请求 api/file - 获取文件信息,下载文件 * POST 方式请求 api/file - 上传创建文件 * DELETE 方式请求 api/file - 删除某个文件