Restful

最新推荐文章于 2023-08-22 12:43:20 发布
最新推荐文章于 2023-08-22 12:43:20 发布
阅读量1.4k 收藏 32
点赞数 4
分类专栏： HTTP 文章标签： Restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Calvin_zhou/article/details/80438424
版权

前言

REST这个词，是Roy Thomas Fielding在他2000年的博士论文中提出的。现在貌似流行了起来，甚至出现过：RESTful API是目前比较成熟的一套互联网应用程序的API设计理论，作为前端设备与后端进行通信的架构，有必要好好熟悉一下。

几个概念对比

既然说到来了Rest，不妨说说相关的几个概念： REST、RESTFUL、SOAP、RPC、RESTFUL Web API；

REST

概念

  • Representational State Transfer
  • REST 是一种软件架构设计风格
  • Fielding在他2000年的博士论文中提出的

约束条件

  1. C/S模型,通过统一接口通讯
  2. 层次化,可与多个服务器通讯
  3. 无状态,服务器不保存客户状态,发送请求时需包含足够信息
  4. Cache,C/S之间可使用缓存
  5. 唯一资源标识来标识资源
  6. 传递消息的自身描述
  7. 返回资源的自身描述
  8. 可选的超媒体即应用状态引擎（HATEOAS）

解释

REST可解释为：表现层状态转化，从一下三个方面讲述

资源（Resources）

解读

  1. REST的名称"中，省略了主语
  2. 表现层"其实指的是"资源"的"表现层
  3. 资源就是网络上的一个实体
  4. 也是网络上的一个具体信息
  5. 可以用一个URI（统一资源定位符）指向它

体现

  1. 一段文本
  2. 一张图片
  3. 一首歌曲
  4. 一种服务

表现层（Representation）

概念

  1. 把"资源"具体呈现出来的形式，叫做它的"表现层"
  2. 在HTTP请求的头信息中用Accept和Content-Type字段指定

体现

  1. 文本可以用txt格式表现
  2. 图片可以用JPG格式表现

状态转化（State Transfer）

概念

  1. 客户端想要操作服务器
  2. 通过某种手段，让服务器端发生"状态转化"

体现

  1. GET(GET用来获取资源)
  2. POST(用来新建(更新)资源)
  3. PUT(用来更新资源)
  4. DELETE(用来删除资源)

RESTFUL

  1. 满足 REST 约束条件的就称为 RESTFUL
  2. 每一个URI代表一种资源
  3. 客户端和服务器之间，传递这种资源的某种表现层
  4. 客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"

SOAP

概念

  1. Simple Object Access Protocol
  2. SOAP 是简单对象访问协议
  3. 是基于xml以及多种协议(http smtp mime)
  4. 使用ws-security来进行安全控制

构建模块

  1. 必需的 Envelope 元素
  2. 可选的 Header 元素，包含头部信息
  3. 必需的 Body 元素，包含所有的调用和响应信息
  4. 可选的 Fault 元素，提供有关在处理此消息所发生错误的信息

RPC

概念

  1. Remote Procedure Call
  2. 通过网络远程调用服务端
  3. RPC 是远程过程调用
  4. 可指定协议(http,tcp,udp)和传输数据格式(json,xml,二进制)

发展历程

  1. 早期的 RPC
  2. XML-RPC，SOAP，WebService
  3. PHPRPC
  4. Hessian
  5. JSON-RPC
  6. Microsoft WCF，WebAPI
  7. ZeroC Ice，Thrift，GRPC
  8. Hprose

RESTFUL Web API

  1. 使用HTTP并遵循REST原则的Web服务
  2. URI 可以完成资源定位
  3. GET、POST、OPTION等方法可以完成资源操作

RESTful API 设计指南

一、协议

HTTPs协议

二、域名

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

三、版本（Versioning）

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

四、路径（Endpoint）

概念

  1. 路径又称"终点"（endpoint）
  2. 表示API的具体网址
  3. 每个网址代表一种资源（resource）
  4. 网址中不能有动词，只能有名词

示例

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

五、HTTP动词

操作

  1. GET（SELECT）：从服务器取出资源（一项或多项）
  2. POST（CREATE）：在服务器新建一个资源
  3. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
  4. PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）
  5. DELETE（DELETE）：从服务器删除资源
  6. HEAD：获取资源的元数据
  7. OPTIONS：获取信息

示例

  1. GET /zoos：列出所有动物园
  2. POST /zoos：新建一个动物园
  3. GET /zoos/ID：获取某个指定动物园的信息
  4. PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
  5. PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
  6. DELETE /zoos/ID：删除某个动物园
  7. GET /zoos/ID/animals：列出某个指定动物园的所有动物
  8. DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

六、过滤信息（Filtering）

概念

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

常见参数

  1. ?limit=10：指定返回记录的数量
  2. ?offset=10：指定返回记录的开始位置
  3. ?page=2&per_page=100：指定第几页，以及每页的记录数
  4. ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
  5. ?animal_type_id=1：指定筛选条件

七、状态码（Status Codes）

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

常见状态码

  1. 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）
  2. 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  3. 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  4. 204 NO CONTENT - [DELETE]：用户删除数据成功
  5. 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  6. 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。

八、错误处理（Error handling）

九、返回结果

  1. GET /collection：返回资源对象的列表（数组）
  2. GET /collection/resource：返回单个资源对象
  3. POST /collection：返回新生成的资源对象
  4. PUT /collection/resource：返回完整的资源对象
  5. PATCH /collection/resource：返回完整的资源对象
  6. DELETE /collection/resource：返回一个空文档

10、身份认证应该使用OAuth 2.0框架

11、服务器返回的数据格式，应该尽量使用JSON，避免使用XML

 

 

PGzxc
关注
  • 4
    点赞
  • 踩
  • 32
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
grpc-http-proxy:grpc http(restful)协议代理或网关
04-16
Grpc-Http-Proxy 将http restful接口访问转换成grpc访问。 相关仓库 https://github.com/generalzgd/grpc-http-proxy https://github.com/generalzgd/protoc-gen-grpc-httpgw https://github.com/generalzgd/grpc-tcp-gateway-proto Proto文件生成 protoc -Iiproto --go_out=plugins=grpc:./iproto ./iproto/backendsvr.proto protoc -Iiproto --grpc-tcpgw_out=logtostderr=true:./iproto ./iproto/httpgate.proto protoc -Iiproto --grpc-httpgw_out
gRPC and RESTful
Ahhhhhaa的博客
07-05 1448
gRPC与RESTful的区别: 相同点：两者都是用于网络之间进行信息传输的某种风格 不同点： 1）传输方式：gRPC采用http2.0，RESTful采用http1.1作为传输协议 2）传输主体：gRPC采用protoBuf格式，RESTful采用json或xml格式 3）序列化：gRPC双端序列化方式相同，但中间人不知。RESTful信息被中间人截取可根据json反序列化解析出原内容，相对来说安全性更高。 因为不同，所以独特 性能gRPC碾压RESTful 1）http1.1和http2.0的不同造
说说RESTFUL中的方法：GET、POST、PUT、PATCH、DELETE、OPTIONS、HEAD、TRACE
热门推荐
mingjia1987的博客
03-22 4万+
        目前互联网公司的应用架构基本都是前后端分离，后端的接口也基本上都是采用restful架构了，接下来就说说restful的使用。使用restful架构最主要的是遵循rest的思想：“统一资源接口“。REST全称：Representational State Transfer，翻译成中文就是“表述性状态转移”，表述的对象就是资源，在web的rertful架构中都是通过uri来一一对应资...
PGSQL生成Restful接口
xcagy-国际性的文档记录中心
08-21 615
header: Prefer:resolution=merge-duplicates {"id":1,"user":"tct","pwd":"5201"} http://127.0.0.1:56456/bi_user?on_conflict=id
API 风格 （三）：RESTful & gRPC
Tdh5258的博客
07-17 997
RESTful VSgRPC 对比项 RESTful gRPC 优点 相对来说，REST更规范、标准、通用，无论哪种语言都支持 HTTP 协议，可以对接外部很多系统，只要满足 HTTP 调用即可。 通常采用 JSON 作为数据通信格式，可读性强，开发调试都很方便。 客户端与服务端之间 松耦合，让变更更加方便。 屏蔽网路细节，像调用本地方法一样，调用远程接口。 通常采用 Protocol Buffers 作为数据传输格式，这种...
restlet restful
11-14
总的来说，"restlet restful"项目是一个基于RESTlet框架的RESTful Web服务实现，提供了便捷的客户端和服务端通信方式，便于开发和测试。通过"RestApplication"类，我们可以创建和管理REST资源，实现对HTTP请求的处理...
restful API
12-05
### RESTful API 设计指南 随着信息技术的飞速发展，前端设备种类繁多，从前的单一桌面电脑到如今的智能手机、平板电脑以及其他专用设备等，这些变化促使了前后端分离的趋势更加明显。为了确保不同前端设备能高效地...
RESTful Architecture
06-17
RESTful架构风格，即Representational State Transfer（表述性状态转移）架构风格，首先并不是一种可以购买的技术或可以添加到软件开发项目中的库。它首先是一种世界观，这种观念将信息提升为我们在构建的架构中的第...
restful.rar
05-02
在Eclipse环境下开发RESTful API，可以使用Spring Boot框架，它提供了对RESTful和JWT验证的强大支持。Spring Security模块可以轻松集成JWT验证，我们可以通过配置拦截器，设置JWT的解析规则和过期策略。此外，Tomcat...
gRPC与RESTful的区别
seabluely
11-10 5054
关于gRPC gRPC 是一个高性能、开源和通用的 RPC 框架，面向服务端和移动端，基于 HTTP/2 设计。 RPC(remote procedure call 远程过程调用)框架目标就是让远程服务调用更加简单、透明。RPC 框架负责屏蔽底层的传输方式（TCP 或者 UDP）、序列化方式（XML/Json/ 二进制）和通信细节。服务调用者可以像调用本地接口一样调用远程的服务提供者，而不需要关心底层通信细节和调用过程。 ·关于RESTful REST（Representational State Tran
RESTful介绍和使用
simon-_-的博客
03-30 909
文章目录RESTful发展背景及简介RESTful架构URI命名规则URL和URI的区别接口示例HTTP动词http响应状态码RESTful的使用结语 RESTful发展背景及简介 网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备…）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API...
浅谈服务器的C/S模型
kongwutianwen的专栏
01-29 3325
过去的一年，做了几个基于C/S模型的客户端和服务器，C/S模型就是“客户端/服务器”模型的简写。基于分享就是最好的学习，所以对其进行回顾是很有必要的。        其实，TCP/IP协议在设计和实现上并没有客户端和服务器概念的区分，它们在通信过程中所有的机器是对等的。但在实际的应用中，尤其是在互联网中，很多数据都被数据提供者所垄断，使得很多网络应用程序不得不采用C/S模型：所有的客户端都通过访
API 接口选择那个？RESTful、GraphQL、gRPC、WebSocket、Webhook
最新发布
比特桃
08-22 9489
本文我们了解了基于 HTTP 应用层协议之上的，常用六种 API 接口：RESTful、GraphQL、gRPC、WebSocket、Webhook。每一个都具有自己鲜明的特色及应用场景，我们应该根据产品以及团队的具体情况才选择使用。没有最好的 API 接口，只有最适合的场景及应用。
谈一下rpc和grpc以及http、RESTful
RayChiu757374816的博客
09-17 1437
rpc和grpc以及http、RESTful的解释
tp5.1 php 前后端分离开发 Restful风格 预请求OPTIONS问题 处理
pyp_demon的博客
11-17 2252
php进行前后端分离开发过程中，当前端使用ajax请求服务器时，如果我们发送的参数为json格式的话，往往会发送两次请求第一次为OPTIONS预请求，第二次则为我们自己定义的请求方式GET、POST或者其它。 本文主要讲的是tp5.1内RESTful风格请求的时候为防止预请求OPTIONS报错的route.php内的路由设置 1.请求格式为json 1）前端发送 $.ajax({ ...
restful 理解
fei33423的专栏
03-30 604
restful 定义: Representational state transfer 核心: 把一切看成资源. id变成了uri path里的一部分. 而不是像之前的变量. james用户拥有的第一辆车里的左边的轮子. htt:xxx.com/user/james/car/1/wheel/left 对这个轮子有: get post(新建) put(修改) del(删除
API架构的选择，RESTful、GraphQL还是gRPC
Java+GO+JS全栈工程师-鹤冲天的博客：编程辅导~商务合作~技术交流
05-21 2786
RESTful、GraphQL和gRPC是三种常见的API架构设计和实现模式，它们在设计理念、数据传输方式和使用场景上都存在这一定的差异，我们在做API实现方案的选型时，要结合具体的应用需求、开发团队的技术能力和技术栈，以及可扩展性等实际需求，来选择适合的方案。要记住的至关重要的一点是：最新的、最流行的不一定是最好的选择。 另外，无论选择哪种架构和协议，重要的是理解其特点、原则和使用方式，并根据具体情况进行合理的设计和优化，以提供高效、可扩展和可靠的API服务。
RestFul、RPC、gRPC、protobuf【gRPC默认使用protocol buffers】【网关和外界的数据传输使用RestFul，微服务内部的各模块之间使用RPC】
u013250861的博客
05-24 454
一、RPC RPC(Remote Procedure Call，远程过程调用)是一种通过网络从远程计算机程序上请求服务，而不需要了解底层网络细节的应用程序通信协议。 RPC协议构建于TCP或UDP,或者是HTTP上。允许开发者直接调用另一台服务器上的程序，而开发者无需另外的为这个调用过程编写网络通信相关代码，使得开发网络分布式程序在内的应用程序更加容易 RPC采用客户端-服务器端的工作模式，请求程序就是一个客户端，而服务提供程序就是一个服务器端。当执行一个远程过程调用时，客户端程序首先先发送一个带有参数的调
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值