Restful Api浅析

已于 2022-01-19 17:20:07 修改
阅读量639 收藏 1
点赞数
分类专栏： 学习笔记 文章标签： restful
于 2022-01-19 17:14:50 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41431286/article/details/122579685
版权

文章目录

前言

提示：以下是本篇文章正文内容，下面案例可供参考

一、Restful Api是什么？

Restful api是一种软件架构风格；主要面向资源；可以降低开发的复杂性，提高系统的可伸缩性。在理解Restful api前先了解Rest：

1.Rest是什么？

Rest（Representation State transfer）：表述性状态转移；那究竟指的是什么的表述呢？其实指的就是资源，任何事物，只要有被引用的必要，都可以称为资源，资源可以是实体，也可以是一个抽象概念；当然一个资源要可以被识别，必须有一个唯一标识，在Web中这唯一标识就是URI；（简单的说是使用URI来表示资源，通过Http的GET、POST、PUT、DELETE方法对资源进行操作。）
URI（Uniform Resource Identifier）：标记资源的唯一标识；既可以看成是资源的地址，也可以看成是资源的名称。如果某些信息没有使用URI来表示，那它就不能算是一个资源， 只能算是资源的一些信息而已。URI的设计应该遵循可寻址性原则，具有自描述性，需要在形式上给人以直觉上的关联。

2.Rest设计规范

(1)、资源。

首先要明确资源就是网络上的一个实体，可以是文本、图片、音频、视频。资源总是以一定的格式来表现自己。文本用txt、html；图片用JPG、JPEG等等。而JSON是RESTful API中最常用的资源表现格式。

(2)、统一资源接口。

RESTful架构遵循统一接口原则，统一接口包含了一组受限的预定义的操作，不论什么样的资源，都是通过使用相同的接口进行资源的访问。如果按照HTTP方法的语义来暴露资源，那么接口将会拥有安全性和幂等性的特性，例如GET和HEAD请求都是安全的， 无论请求多少次，都不会改变服务器状态。而GET、HEAD、PUT和DELETE请求都是幂等的，无论对资源操作多少次， 结果总是一样的，后面的请求并不会产生比第一次更多的影响。（简单来讲对于业务数据的CRUD，RESTful 用HTTP方法与之对应。）

(3)、使用无状态请求模型。

HTTP 请求应该是独立的，并且可以以任何顺序发生，因此保持请求之间的瞬态信息是不可行的。唯一存储信息的地方是资源本身，每个请求都应该是一个原子操作。此约束使 Web 服务具有高度可扩展性，因为不需要保留客户端和特定服务器之间的任何关联。任何服务器都可以处理来自任何客户端的任何请求。也就是说，其他因素可能会限制可扩展性。例如，许多 Web 服务写入后端数据存储，这可能难以横向扩展。

(4)、URI。

URI，统一资源标识符，它可以唯一标识一个资源。注意到，URL(统一资源定位符)是一种URI，因为它可以唯一标志资源。但URL != URI。应该说URL 是URI的子集。因为URL使用路径来唯一标识资源，这只是唯一标识资源的一种方式。还可以用一个唯一编号来标识资源，如example.html.fuce2da23。只不过这种方式并不被广泛使用。总之，要在概念上对URL和URI有所区分。

(5)、URL中使用名词且为复数，尽量不使用动词。

这是因为在REST要求对资源的操作由HTTP 方法给出，而方法是由HTTP 请求报文头部给出的，自然不需要在URL中暴露操作方式。（不符合CRUD的，可以使用动词）

其实Restful API 就是基于REST风格的API，接下来了解下Restful API

3.Restful API的设计原则

(1)、协议（schema）

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

(2)、域名

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

https://api.example.com

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

https://api.example.com/api
(3)、版本 (version)

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

https://api.example.com/v1/
https://api.example.com/v2/
(4)、路径（Endpoint）

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

https://api.example.com/v1/apples
https://api.example.com/v1/peers
(5)、Http动词

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

	GET（SELECT）：从服务器取出资源（一项或多项）。
	POST（CREATE）：在服务器新建一个资源。
	PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
	PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
	DELETE（DELETE）：从服务器删除资源。

还有两个不常用的动词：

	HEAD：获取资源的元数据。
    OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
(6)、过滤信息（Filtering）

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

常见的参数如下：

https://api.example.com/v1/peers?limit=10：指定返回记录的数量
https://api.example.com/v1/peers?offset=10：指定返回记录的开始位置。
https://api.example.com/v1/peers?page=2&per_page=100：指定第几页，以及每页的记录数。
https://api.example.com/v1/peers?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
https://api.example.com/v1/peers?animal_type_id=1：指定筛选条件
(7)、状态码（Status Code）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
(8)、异常处理（Error handing）

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

{
  error: 'Invalid API key'
}
(9)、预期返回结果

当使用不同的HTTP动词向服务器请求时，客户端需要在返回结果里面拿到一系列的信息。下面的列表是非常经典的RESTful API定义：

GET /collection: 返回一系列资源对象
GET /collection/resource: 返回单独的资源对象
POST /collection: 返回新创建的资源对象
PUT /collection/resource: 返回完整的资源对象
PATCH /collection/resource: 返回完整的资源对象
DELETE /collection/resource: 返回一个空文档
(10)、认证 （Authentication）

服务器在大多数情况下是想确切的知道谁创建了什么请求。当然，有些API是提供给公共用户（匿名用户）的，但是大部分时间里也是代表某人的利益。

OAuth2.0提供了一个非常好的方法去做这件事。在每一个请求里，你可以明确知道哪个客户端创建了请求，哪个用户提交了请求，并且提供了一种标准的访问过期机制或允许用户从客户端注销，所有这些都不需要第三方的客户端知道用户的登陆认证信息。

还有OAuth1.0和xAuth同样适用这样的场景。无论你选择哪个方法，请确保它为多种不同语言/平台上的库提供了一些通用的并且设计良好文档，因为你的用户可能会使用这些语言和平台来编写客户端。

参考：

链接: RESTful API 最佳实践
链接: RESTful Web API 设计

Contrivance
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
c c++实现http服务 c c++开发restful api服务
02-11
此代码通过c c++实现一个简单的http服务,可以用此实现一个restful api 服务器.
RESTful风格API
一条小黑龙的博客
08-15 859
什么是RESTful RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。 RESTFUL特点包括： 每一个URI代表1种资源 客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来
C++ restful api使用
最新发布
weixin_43803780的博客
05-25 569
4. **定义处理函数**: 为不同的HTTP动词（GET, POST, PUT, DELETE等）定义处理函数。3. **设置HTTP监听器**: 创建一个`http_listener`对象并绑定到一个URL上。2. **包含必要的头文件**: 在你的C++源文件顶部，你需要包含CppRESTSDK的头文件。5. **注册处理函数**: 将这些函数注册到监听器上，以便它们可以响应相应的HTTP请求。6. **启动监听器**: 最后，启动监听器来开始接收和处理请求。// 处理POST请求的逻辑。
【RESTful API】RESTful API 接口协议
wjianwei666的专栏
08-25 808
RESTful API（Representational State Transfer）是一种基于HTTP协议的API设计规范，通过URL、HTTP方法、HTTP状态码和HTTP头部等方式来实现资源的访问和交互，使得API具有可读性、可维护性、可扩展性和可靠性。
RESTful 架构详解
科大浪子的专栏
07-28 3683
1. 什么是REST REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。 他在论文中提到："我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得
RESTfulAPI详解
一个优秀的极客「白泽」
02-20 1万+
1. 什么是RESTfulAPI RESTful API 是一种互联网软件架构的设计规范，设计指南，设计风格，设计原则（类似于web标准，并不是标准【规范，原则】） 2. 产生背景 开始开发时，前后端高度融合（耦合） 近些年：前后端分离，前端各种客户端产生。基于这种现状，需要一个统一的机制。为前后端通信服务（API机制） 因此，前后端分离开来前后端基于API 开发，即：面向接口开发 前后端基于接口传递数据。 RESTfulAPI作为制定接口标准的规范而产生了。 3. RESTful API API简介：
浅析Node在构建超媒体API中的作用
09-04
例如，`node-restify`和`node-restful`这两个库，专门为创建RESTful API提供便利。`node-restify`提供了一种轻量级且灵活的方式来构建API，而`node-restful`则是对Express框架的封装，适用于快速构建RESTful服务。...
深入浅析Restful接口的两种使用方式
08-26
深入浅析Restful接口的两种使用方式 Restful接口是一种基于HTTP协议的Web服务架构风格，通过使用HTTP协议的方法来操作和访问资源。Restful接口的两种使用方式是GET和POST，这两种方式是最常用的RESTful接口使用方式...
Android通过WebService连接SQLServer浅析.pdf
09-22
2. 引用 WebService：在 Android 应用程序中引用 WebService，通过 SOAP 或 RESTful API 与 WebService 进行交互。 3. 实现数据交互：Android 应用程序通过 WebService 与 SQL Server 进行数据交互，实现数据的实时...
ASP.NET深入浅析
10-08
- **Web API**: ASP.NET Web API是构建RESTful服务的框架，适用于创建HTTP服务，可以被多种客户端，如浏览器、移动设备或桌面应用访问。 - **Razor视图引擎**: Razor语法使得在HTML中嵌入C#代码变得更加简洁，是...
Django-Rest-Framework 权限管理源码浅析(小结)
09-19
Django Rest Framework(DRF)是基于Django的一个强大的Web API构建框架，它简化了创建美观、易用且功能丰富的RESTful API的过程。在DRF中，权限管理是至关重要的一个部分，确保只有授权用户能够访问特定的API资源。...
C++实现简单RESTful服务
Dontla的博客
02-18 2257
下面是一个使用libmicrohttpd和jsoncpp的简单RESTful服务示例。假设你的C++程序需要提供一个名为"add"的RESTful接口，它需要接收两个整数参数，并返回它们的和。这里的代码是在Linux平台下编写的。在C++中实现RESTful服务的一种常见方法是使用HTTP服务器库和JSON解析器，例如libmicrohttpd和jsoncpp。在上面的代码中，handleRequest()方法将处理"GET /add"请求，并返回JSON格式的响应。注意：代码未经验证，严禁上线！
RESTful API 概述
叁木大数据
03-11 3098
RESTful API 是一种基于 REST 架构风格设计的 Web API。而在讲其之前我们应该先去聊聊REST，。而RESTful API 通常基于 HTTP 协议进行通信，通过 URI（Uniform Resource Identifier，统一资源标识符）指定资源的位置，通过 HTTP 方法（GET、POST、PUT、DELETE 等）操作资源，通过 HTTP 状态码表示请求的处理结果。
RESTful简介与C/C++实现
笔者从事电信媒体开发多年，愿意将多年的开发经验分享给同行
12-21 2639
RESTful，全称为Representational State Transfer，是一种软件架构风格和设计理念，而不是一种标准。它主要用于Web服务的设计和开发，强调资源的状态表示和状态转移。RESTful风格的设计使得Web服务更加简洁、清晰和易于理解。本文结合RESTful、HTTP及C++进行了简单介绍。
c++实现restful api服务（附完整源码）
希望我的博客，能帮上你解决学习中工作中所遇到的问题
06-25 1122
c++实现restful api服务（附完整源码）
深入探索cpprest库：现代化的C++ RESTful编程
CarryMee的博客
08-07 3233
cpprest（又称为Casablanca）是一个开源的C++库，专注于实现现代化、异步的RESTful编程。它提供了一组简洁而强大的API，用于构建客户端和服务器端的HTTP请求和响应，让开发者能够轻松地构建高性能的Web应用程序。本文将详细介绍cpprest库的特性和使用方法，并给出每个请求用法的示例。
Restful API是什么、为什么、怎么使用
渐若窥宏大的博客
03-21 3261
Restful API 文章目录Restful API1、REST是什么以及它的 6 个限制REST是什么？REST的6个限制2、 Restful是什么Restful是什么RESTful API具体什么样子？现实举例从资源出发3、为什么要使用RestfulHTTP协议-URLHTTP协议-请求HTTP协议-响应RESTful架构与其他架构的区别效率和易用性安全性4、 如何使用Restful资源路径...
HTTP报文格式&请求方法&HTTP状态码&RESTful API
weixin_44915595的博客
12-16 659
报文格式 2XX——表明请求被正常处理了 200 OK：请求已正常处理。 202 Accepted：服务器已接受请求，但尚未处理。正如它可能被拒绝一样，最终该请求可能会也可能不会被执行。在异步操作的场合下，没有比发送这个状态码更方便的做法了。 204 No Content：请求处理成功，但没有任何资源可以返回给客户端，一般在只需要从客户端往服务器发送信息，而对客户端不需要发送新信息内容的情况下使用。 206 Partial Content：是对资源某一部分的请求，该状态码表示客户端进行了范围请求，而服务器成
什么是RESTful API?
热门推荐
Evan's Blog ٩(๑❛ᴗ❛๑)۶
12-25 9万+
        提到RESTful API 大家势必或多或少听说过。但是什么是RESTful API ？如何理解RESTful API 呢？请大家耐心读完这篇文章，相信您读完后一定会有一个更好的理解。我个人认为，要弄清楚什么是RESTful API,首先要弄清楚什么是REST。REST 全称：REpresentational State Transfer，英文翻译过来就是“表现层状态转化”。如果...
RESTful API设计指南
"RESTful API设计规则书，作者Mark Massé，详细讲述了如何设计RESTful API。" 本书《RESTful API设计规则书》是Mark Massé的作品，主要关注于RESTful API的设计方法。REST（Representational State Transfer）是...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值