了解RestfulAPI的基本概念

最新推荐文章于 2021-06-25 10:48:34 发布
最新推荐文章于 2021-06-25 10:48:34 发布
阅读量257 收藏
点赞数
mtdg
本文链接：https://blog.csdn.net/m0_46266407/article/details/105487350
版权

【今日推荐】：为什么一到面试就懵逼！>>> hot3.png

  • 目录
  • 1. RESTful是什么？
  • 2. 设计概念和准则
  • 3. HTTP协议介绍
  • 4. HTTP响应协议
  • 5. SOAP架构与RESTful架构区别
  • 5.1 效率和易用性区别
  • 5.2 安全性区别
  • 6. 设计要素
  • 6.1 资源路径
  • 6.2 HTTP动词
  • 6.3 过滤信息
  • 6.4 状态码
  • 6.5 错误处理
  • 6.6 返回结果
  • 7. 总结

1.RESTful是什么？

本质：一种软件架构风格

核心：面向对象

解决问题：降低开发复杂性；提高系统可伸缩性

2.设计概念和准则

  • 网络上的所有事物都可以被抽象为资源.
  • 每一个资源都有唯一的资源标识,对资源的操作不会改变这些标识.
  • 所有操作都是无状态的.

3.HTTP协议介绍

HTTP是一个属于应用层的协议,特点是简捷和快速。

HTTP请求协议组成格式:

请求行

消息报头

请求正文

请求行格式:

Method Request-URI HTTP-Version CRLF

举例:

GET/HTTP/1.1 CRLF

请求方法：

  • GET : 请求获取Request_URI所标识的资源
  • POST : 在Request-URI所标识的资源后附加新的数据
  • HEAD : 请求获取由Request_URI所标识的资源的响应消息报头
  • PUT : 请求服务器存储一个资源,并用Request_URI作为其标识
  • DELETE : 请求服务器删除Request_URI所标识的资源
  • OPTIONS : 请求查询服务器的性能,或者查询与资源相关的选项和需求

4.HTTP响应协议

组成格式:

状态行

消息报头

响应正文

常用状态码：

  • 200 OK 表示成功
  • 400 Bad Request 表示客户端语法错误,不能被服务器所理解
  • 401 Unaauthorized 表示服务器接受到请求但拒绝提供服务
  • 404 Not Found 表示请求资源不存在
  • 500 Internal Server Error 服务器错误
  • 503 Server Unavailable 服务器不能处理客户端的请求

5.SOAP架构与RESTful架构区别

SOAP WebService是一种跨编辑语言和跨操作系统平台的远程调用技术.通过http协议发送请求和接受结果时采用XML格式封装,并增加一些特定的HTTP消息头,这些特定的HTTP消息头和XML内容格式就是SOAP协议.

5.1 效率和易用性区别

SOAP由于各种需求不断扩充其本身协议内容,导致在SOAP处理方面的性能有所下降,同时在易用性方面以及学习成本上有所增加.

而RESTful由于其面向资源接口设计以及操作抽象简化了开发者的不良设计,同时也最大限度的利用了HTTP最初的应用协议设计概念.

总结:SOAP的效率和易用性比不上RESTful

5.2 安全性区别

RESTful对于资源型服务接口来说很适合,同时特别适合对于效率要求很高,但对于安全要求不高的场景.

而SOAP的成熟性可以给需要提供给多开发语言的,对于安全性要求较高的接口设计带来便利.

总结:SOAP安全性比RESTful高

6.设计要素

设计流程：资源路径(URL)->状态码->HTTP动词->错误处理->过滤信息->返回结果

6.1 资源路径

在RESTful架构中,每个网址代表一种资源,所以网址中不能有动词,只能有名词,一般来说API中的名词要用复数.

举例：有一个API提供动物园的信息，还包括各种动物和雇员的信息，则资源路径设置如下

6.2 HTTP动词

对资源的CURD操作,由于HTTP动词表示.

  • GET : 从服务器取出一项或多项资源
  • POST : 在服务器新建一个资源
  • PUT : 在服务器更新资源(客户端提供改变后的完整资源)
  • PATCH : 在服务器更新资源(客户端提供改变的属性)
  • DELETE : 从服务器删除资源

举例：

  • POST/zoos：新建一个动物园
  • GET/zoos/ID:获取某个指定动物园信息
  • PUT/zoos/ID：更新某个指定动物园信息
  • DELETE/zoos/ID：删除某个动物园

6.3 过滤信息

如果记录数量很多,服务器不可能都将数据返回给用户,此时,API应该提供参数,过滤返回结果.

举例：

域名?page=2&&name=fangzhijie

6.4 状态码

服务器向用户返回的状态码和提供信息,使用标准的HTTP状态码.

  • 200 OK 服务器成功返回用户请求数据,该操作是幂等的.
  • 201 CREATED 新建或修改数据成功
  • 204 NO CONTENT 删除数据成功
  • 400 BAD REQUEST 用户发出的请求有错误,该操作是幂等.
  • 401 Unauthrized 表示用户没有认证,无法进行当前操作
  • 403 Forbidden 表示用户访问是被禁止的
  • 422 Unprocesable Entity 当创建一个对象时候,发生一个检验错误.
  • 500 INTERNAL SERVER ERROR 服务器发生错误,用户将无法判断发出的请求是否成功

6.5 错误处理

如果状态码是4xx或者5xx,就应该向用户返回出错信息.一般来说,返回的信息将error作为键名,出错信息作为键值即可,格式如下:

{

“error” :  “参数错误”

}

6.6 返回结果

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

  • GET/collections : 返回资源对象列表(数组)
  • GET/collections/identity : 返回单个资源对象
  • POST/collections : 返回新生成的资源对象
  • PUT/collections/identity : 返回完整的资源对象
  • PATCH/collections/identity : 返回被修改的属性
  • DELETE/collections/identity : 返回一个空文档

7.总结

上面就是我对RESTFUL API的基础概念总结,下面我还会出一章对RESTFUL API的实战篇,从实战看看要注意什么,接口究竟如何设计,最后,我们大家一起加油鸭~

拯救世界的派大星
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
RESTful 个人理解总结
adviceuser2014的博客
06-28 1904
一.什么是RESTful 面向资源 简单的说：RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构。 先看REST是什么意思，英文Representational state transfer 表述性状态转移 其实就是对 资源 的表述性状态转移。 （什么是表述性：就是指客户端请求一个资源，服务器拿到的这个资源，就是表述） 资源的地址 在web...
RESTful API的理解
热门推荐
首都浪子的博客
02-13 11万+
什么是REST,RESTful API？
RESTful架构基本概念
逍遥绝情的博客
05-15 1366
1.什么是rest 1.REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 2.REST本身并没有创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力， 更好地使用现有Web标准中的一些准则和约束。 2.理解RESTful 1.资源与URI 1.要让一个资源可以被识别，需要有个唯一标识
了解什么是RESTFUL API
这天有点热的博客
08-27 280
1.REST 是 Representational State Transfer 的缩写。 2.所有的东西都是资源，所有的操作都是通过对资源的增删改查来实现的。 rest 是设计风格不是标准。 Rest的特性： 1.资源 2.所有操作都是无状态的，即不使用session。 Rest操作： url：http://someshop/apples get：/apples   获取苹果的列...
RESTFUL - 基础概念
心火燃烧！
11-09 179
REST是什么？ REST（英文：Representational State Transfer，简称 REST）描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，Roy Fielding是 HTTP 规范的主要编写者之一。在目前主流的三种Web服务交互方案中，REST相比于SOAP（Simple Object Access ...
RestFul API 案例
07-31
以上就是关于RESTful API的基本知识点，结合提供的"RestFul API.pptx"和"TEST.zip"文件，你可以深入学习具体的案例，了解如何设计和实现一个RESTful API。实践中，我们通常会用到如Spring Boot这样的框架来快速构建...
Golang Gin RESTFul API with SQLite
05-09
【Golang Gin RESTFul API with ...总之，这个项目旨在帮助开发者了解如何使用Gin和SQLite构建高效、可扩展的RESTful API。通过学习和实践，你可以掌握Go语言的Web开发技巧，以及如何设计和实现一个完整的API服务。
使用PowerShell测试您的RESTful API
04-07
1. **了解PowerShell的基本概念** - PowerShell工作台：PowerShell的工作环境，允许执行命令和脚本。 - cmdlet：PowerShell中的命令模块，是一组预定义的、面向对象的命令。 - PowerShell管道：允许将一个cmdlet...
yii2项目实战之restful api授权验证详解
10-19
总的来说，Yii2项目实战之RESTful API授权验证的实现，需要我们了解RESTful API的基本概念，掌握如何在Yii2框架中配置路由和过滤器，以及如何处理认证类和Token的生成与校验。这些步骤是构建一个安全、可用的RESTful...
RestfulAPI-来自
02-15
首先，让我们了解RESTful API的基本概念。RESTful API的核心是资源（Resource），通过HTTP方法（GET、POST、PUT、DELETE等）来操作这些资源。例如，使用GET方法获取资源，POST方法创建新资源，PUT方法更新现有资源，...
Restful的概念
darknightbatman的博客
02-22 247
实际应用 什么是restful: 1、Rest： 表述性状态转移 – 资源的表述 – url地址资源 2、并不是一个创新的技术，是一组架构约束的条件和原则； 3、只要符合rest约束的条件和原则的架构，称之为restful架构 资源的表述：客户端和服务器端之间数据的传送就是资源的表述 Restful核心内容： 1、资源和url 2、资源的表述 3、状态转移 结构的特点： 1、统一了客户端访问资源的...
restful概念
weixin_41490593的博客
07-08 244
https://www.runoob.com/w3cnote/restful-architecture.html 上面这个很清楚解析restful和资源
RESTful--概念学习
fhzheng for c java javascript sql html css
04-01 280
什么是RESTful REST本身即Representational State Transfer表述性状态转移 它是一种架构风格，它定义了创建可扩展Web服务的最佳实践，这个过程会充分发挥HTTP协议的功能。 RESTful的属性 1 客户端-服务器：UI是与数据存储分离的 2 无状态：每个请求会包含服务器所需的足够信息，无需维护状态就能够进行操作 3 可缓存：服务器的响应中包含了足够的需求，客...
RESTful API是什么？
IChen.的博客
06-25 573
要弄清楚什么是RESTful API，首先要知道REST是什么。 REST，表示性状态转移（representation state transfer）。简单来说，就是用URI表示资源，用HTTP方法(GET, POST, PUT, DELETE)表征对这些资源的操作。 Resource: 资源，即数据，存在互联网上的可被访问的实体 Representation： 数据的某种表现形式，如HTML, JSON。 State Transfer：状态变化，HTTP方法实现 RESTful API 就是.
Restful API是什么？
xiasohuai的博客
02-08 287
Restful API 从字面就可以知道，他是rest式的接口，所以就要先了解什么是rest rest 不是一个技术，也不是一个协议 rest 指的是一组架构约束条件和原则，提供了一个新的架构设计思路，满足这些约束条件和原则的应用程序或设计就是 RESTful。 RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。 为什么用Restful API 例如常用的M...
restful概念理解
丫头的博客
09-07 477
一、概念 1.    rest概念：    REST（representational state transfer）表现层状态转移化，省略了主语。"表现层"其实指的是"资源" （Resources）的" 表现层"。  ①资源：所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统
什么是restful API ?
missTu~的博客
05-31 1765
1、什么是API API是应用程序接口，可 理解为程序与程序之间通信的桥梁，其本质就是一个函数而已。 2、RESTful API REST 的全称是 Resource Representational State Transfer ，直白地翻译过来就是 “资源”在网络传输中以某种“表现形式”进行“状态转移” 。 资源（Resource） ：我们可以把真实的对象数据称为资源。一个资源既可以是一个集合，也可以是单个个体。比如我们的班级 classes 是代表一个集合形式的资源，而特定的 class 代表单个个
认识一下什么是RestfulAPI
longlong6682的博客
05-11 3448
这里写目录标题一. RestfulAPI与HTTP简介1、什么是RestfulAPI2、HTTP的第一行包含三个信息：谓词、URL、HTTP协议版本。三个数据使用空格隔开3、RestFul API中常用的HEAD信息4、用一张图为大家展示一下这些知识二. RestfulAPI使用举例1、创建django项目testRestfulAPI 一. RestfulAPI与HTTP简介 1、什么是RestfulAPI REST直接翻译：表现层状态转移，实质就是一种面向资源编程的方法 REST描述的是在网络中cli
RESTFUL概念及实践
shijunwang的博客
03-18 353
一：定义： REST是英文representational state transfer(表象性状态转变)或者表述性状态转移;Rest是web服务的一种架构风格;使用HTTP,URI,XML,JSON,HTML等广泛流行的标准和协议;轻量级,跨平台,跨语言的架构设计;它是一种设计风格,不是一种标准,是一种思想。 对应的中文是rest式的;Restful web service是一种常见的rest的应
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值