RESTful介绍

最新推荐文章于 2023-03-29 14:08:30 发布
最新推荐文章于 2023-03-29 14:08:30 发布
阅读量184 收藏 1
点赞数
文章标签： python 数据结构与算法 数据库
原文链接：http://www.cnblogs.com/jiumo/p/10098145.html
版权

RESTful规范

​ 编程是数据结构和算法的结合，而在Web类型的App中，我们对于数据的操作请求是通过url来承载的，本文详细介绍了REST规范和CBV请求流程。

​ 编程是数据结构和算法的结合，小程序如简单的计算器，我们输入初始数据，经过计算，得到最终的数据，这个过程中，初始数据和结果数据都是数据，而计算过程是我们所说的广义上的算法。

​ 大程序，如一个智能扫地机器人，我们可以设置打扫的距离，左右摆动的幅度来打扫房间，这里面打扫的举例，摆动幅度，都是数据，而打扫的过程是较为复杂的算法过程，总之，也是算法，即程序的实现方式。

​ 另外，我们还可以设置打扫时间等等初始数据。

​ 总之一句话，编程即数据结构和算法的结合。简单的程序可能不需要跟用户交互数据，但是现代的应用程序几乎都需要跟用户进行交互，不分应用程序类型，不管是CS型还是BS型的程序都是如此，而Python最擅长的Web App即BS型的程序，就是通过url和http来跟用户进行数据交互的，通过url和http请求，用户可以操作服务器端的程序，主要操作分为：增、删、改、查几类。

引入

在开始之前，我们回顾一下咱们之前写过的图书管理系统项目，请仔细回想一下，对于该项目的设计，我们大概是以下面这种方式来实现的

传统url设计风格
  • url各式各样，设计混乱

DRF

理论上来说，这种方式完全可以实现我们的需求，但是一旦项目丰富起来，随着数据量增加，随着各个业务系统之间的逻辑关系不断的复杂，url会越来越复杂，理论上来说，不管是什么类型、什么名称的url都能指向具体的业务逻辑（视图函数），从而实现业务需求，但是如果没有明确的规范，因每个人的思维方式不一样、命名方式不一样而导致的url非常的乱，不方便项目的后期维护和扩展。

  • 对于请求处理成功或者失败的返回信息没有明确的响应信息规范，返回给客户端的信息往往都是很随意的

以上这些情况的出现，导致了很多的问题，让互联网的世界变得杂乱不堪，日益复杂且臃肿。因此http协议创始人警告我们这些凡人们正在错误的使用http协议，除了警告，他还发表了一篇博客，大概意思就是教大家如何正确使用http协议，如何正确定义url，这就是REST（Representational State Transfer），不需要管这几个英文单词代表什么意思，只需要记住下面一句话：

  • 用url唯一定位资源，用Http请求方式（GET, POST, DELETE, PUT)描述用户行为

根据这句话，我们重新定义图书管理系统中的url

RESTful Api设计风格

DRF

可以看到，url非常简洁优雅，不包含任何操作，不包含任何动词，简简单单，用来描述服务器中的资源而已，服务器根据用户的请求方式对资源进行各种操作。而对数据的操作，最常见的就是CRUD（创建，读取，更新，删除），通过不同的请求方式，就足够描述这些操作方式了。如果不够用，Http还有其他的请求方式呢！比如：PATCH，OPTIONS，HEAD, TRACE, CONNECT。

REST定义返回结果

DRF

每一种请求方式的返回结果不同。

REST定义错误信息
{
    "error": "Invalid API key"
}

通过一个字典，返回错误信息。

这就是REST，上图中的url就是根据REST规范进行设计的RESTful api。

概念

REST是一种软件架构设计风格，不是标准，也不是具体的技术实现，只是提供了一组设计原则和约束条件。是目前最流行的 API 设计规范，用于 Web 数据接口的设计。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。2000年，由Roy Fielding在他的博士论文中提出，Roy Fielding是HTTP规范的主要编写者之一。

URL规范

​ 1.不用大写；

​ 2.用中杠 - 不用下杠 _ ；

​ 3.参数列表要encode；

​ 4.URI中的名词表示资源集合，使用复数形式。

​ 5.在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词（特殊情况可以使用动词），而且所用的名词往往与数据库的表格名对应。

restful 规范

       1. 根据method不同，进行不同操作
           GET/POST/PUT/DELETE/PATCH
       2. 面向资源编程
           http://www.nnblog.com/blog
       3. 体现版本
           http://www.nnblog.com/v1/blog
           http://www.nnblog.com/v2/blog     
           https://v4.bootcss.com/
           https://v3.bootcss.com/
       4. 体现是API
           http://www.nnblog.com/api/v1/blog
           http://www.nnblog.com/api/v2/blog  
            
           http://api.nnblog.com/v1/salary
           http://api.luffycity.com/v2/blog   
       5. https
           https://www.nnblog.com/api/v1/blog
           https://www.nnblog.com/api/v2/blog   
       6. 响应式设置状态码
           200
           300
           400
           500
           return HttpResponse('adfasdf',status=300)
       7. 条件
           https://www.nnblog.com/api/v2/blog?page=1&size=10
       8. 返回值
           https://www.nnblog.com/api/v2/salary
           GET: 所有列表
           {
               code: 10000,
               data: [   
                   {'id':1,'title':'a'},
                   {'id':1,'title':'b'},
                   {'id':1,'title':'c'},
               ]
           }
                
           POST: 返回新增的数据
               {'id':1,'title':'高亮'}
                
           https://www.nnblog.com/api/v2/salary/1/
           GET: 获取单条数据
                   {'id':1,'title':'d'}
           PUT：更新
                   {'id':1,'title':'e'}
           PATCH: 局部更新
                   {'id':1,'title':'f'}
           DELETE：删除          
       9. 返回错误信息
           {
               code: 100001,
               error: 'xxx错误'
           }      
       10. Hypermedia API
           ret = {
               code: 1000,
               data:{
                   id:1,
                   name:'jiumo',
                   depart_id:http://www.nnblog.com/api/v1/blog/8/
               }
           }
Request
url唯一定位资源（数据），http请求方式描述用户行为
    GET    127.0.0.1:8000/books/     # 获取所有数据
    POST   127.0.0.1:8000/books/     # 添加一条数据
    PUT    127.0.0.1:8000/books/{id} # 修改一条数据
    DELETE 127.0.0.1:8000/books/{id} # 删除一条数据
    GET    127.0.0.1:8000/books/{id} # 获取单条数据
Response
返回数据规范
    GET    127.0.0.1:8000/books/     # 获取所有数据  [ {}, {}, {}]
    POST   127.0.0.1:8000/books/     # 添加一条数据  {}
    PUT    127.0.0.1:8000/books/{id} # 修改一条数据  {}
    DELETE 127.0.0.1:8000/books/{id} # 删除一条数据  ""
    GET    127.0.0.1:8000/books/{id} # 获取单条数据  {}
    
错误信息
    { "error": "error_message" }
状态码
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

URI失效:
    随着系统发展，总有一些API失效或者迁移，对失效的API，返回404 not found 或 410 gone；对迁移的API，返回 301重定向。

那么，Django RestFramework与rest有什么关系呢？

其实，DRF(Django RestFramework)是一套基于Django开发的、帮助我们更好的设计符合REST规范的Web应用的一个Django App，所以，本质上，它是一个Django App。

转载于:https://www.cnblogs.com/jiumo/p/10098145.html

diaodu8047
关注
RESTful介绍和使用教程
m0_68006260的博客
06-07 576
REST（Representational State Transfer）表象化状态转变（表述性状态转变），在2000年被提出，基于HTTP、URI、XML、JSON等标准和协议，支持轻量级、跨平台、跨语言的架构设计。是Web服务的一种新的架构风格（一种思想）代码不被侵入（正例：SpringMVC中不用接口和继承，仅用注解完成。反例：Struts中每一个Action都要继承核心控制器），轻量级跟包大小无关。耦合性越低，越轻量。符合上述REST原则的架构方式称为RESTfulURI：http://exampl
RARF：基于响应式抽象资源流的深度 RESTful 实践
weixin_34212189的博客
03-14 173
GitHub Repo: https://github.com/wxyyxc1992/RARF Why RARF? 本文仅代表个人思考，若有谬误请付之一笑。若能指教一二则感激不尽。另外本文所写是笔者个人的思考，暂未发现有类似的工作。不过估计按照笔者的智商可能世界上已经有很多大神早就解决了笔者考虑的问题，若有先行者也不吝赐教。 在文章之初，...
restful 响应式_响应式RESTful API中电子表格的强大功能
danpu0978的博客
05-14 147
restful 响应式 作为一名技术人员，当我偶然发现这篇关于Espresso Logic的热门文章时，我被自己的Dilbertesque态度所欺骗。 曾经关心过我的社交媒体声誉（例如reddit和hackernews karma），我认为在这些平台上建立一个链接很有趣，标题为： 刚刚在TechCrunch上找到了这篇文章。 读起来像是由markov-chain生成的一系列流行词。 有...
Restful介绍
qq_30984561的博客
05-27 399
Restful风格 restful是一种软件设计规范，是客户端和服务端进行数据交互的规范。 在restful中： 提取资源： 也是最关键的一步，对于资源的识别不算太难，一般情况下资源即是想要处理的对象 URI的设计： 对网络上所有的资源都有一个资源标志符，一个URL操作一个资源，请求的URL不能有动词， 具体的操作：GET：获取资源的方法；PUT：更新资源的方法；POST：创建资源的方法；DELE...
RESTful 简介
salahi的专栏
03-29 810
REST（Representational State Transfer）是一种通过 HTTP 协议进行通信的软件架构风格，常用于 Web 应用程序的设计和开发。RESTful 是遵循 REST 原则的 Web API 的称谓，它提供了一组定义良好的操作（如 GET、POST、PUT、DELETE 等），通过这些操作对资源（如文件、图像、视频等）进行管理。
restful 简单介绍
茄子的博客
11-22 214
首先声明这是一种风格不是一种技术，是一种思想， 理论定义： 网络上的所有事物都被抽象为资源， 每个资源都有一个唯一的资源标识符     同一个资源具有多种表现形式(xml,json等)，  对资源的各种操作不会改变资源标识符     所有的操作都是无状态的， 符合REST原则的架构方式即可称为RESTful 解释Restful 这是遵循了rest风格的架构的应用， 比如http 的增...
RestFul服务介绍
11-21
### RestFul服务介绍 #### 1. REST介绍 REpresentational State Transfer (REST) 是一种软件架构风格，尤其适用于构建网络应用。REST的核心理念是将互联网上的数据视为一系列资源，每个资源都可以通过一个唯一的...
Flask扩展库的利用：Flask-RESTful介绍
Flask框架和RESTful API简介 Flask 是一个轻量级的 WSGI Web 应用程序框架。它由 Python 编写，基于 Werkzeug WSGI 库和 Jinja2 模板引擎。Flask 的设计简单而灵活，易于扩展。以下是一些 Flask 框架的特点： ## ...
RESTful介绍和yii2中RESTful如何配置
小白
09-02 5764
RESTful介绍和yii2中RESTful如何配置   REST的名称"表现层状态转化"中，省略了主语。"表现层"其实指的是"资源"（Resources）的"表现层"。 从学术上来讲：    RESTful提出的初衷，是考虑到长期以来，软件研究主要关注软件设计的分类、设计方法的演化， 很少客观地评估不同的设计选择对系统行为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、 如何
Restful架构
tanguang_honesty的专栏
08-17 1526
Restful架构  今天抽空整理些有关rest方面的理论。主要参考了几篇网上的文章，做了些整理，原文见附录。 一、起源 越来越多的人开始意识到，网站即软件，而且是一种新型的软件。 这种"互联网软件"采用客户端/服务器模式，建立在分布式体系上，通过互联网通信，具有高延时（high latency）、高并发等特点。 网站开发，完全可以采用软件开发的模式。但是传统上，软件和网
REST --URL定位资源
过去过去，未来未来，当下永恒！
04-09 732
URL定位资源，用HTTP动词（GET,POST,DELETE,DETC）描述操作 REpresentational State Transfer 直接翻译：表现层状态转移 使用Rest前，首先说一说Rest请求方式的好处，首先就是面向资源URI，即http请求的路径，Rest规定中要求URI各层只能用名词不用动词，这样相比传统的get请求有利于传输数据的稳定性，数据的操作流程不会被人轻易看破，也...
Rest风格的请求方式
去宇宙
04-17 4万+
关注作者更多博客，一起学习一起进步 Spring自定义注解学习：https://blog.csdn.net/qq_34582693/article/details/88943120 JVM底层原理学习：https://blog.csdn.net/qq_34582693/article/details/79513676 JAVA多线程学习：https://blog.csdn.net/qq_34...
Restful API 服务端编写和连接Sql Server数据库实现数据持久化(一)
build2024
05-19 1599
1.项目准备 一.开发环境 vs2015 二.net framework版本4.5.2 三.Nuget安装SqlSugar(第三方中间件，非常好用) 官网：https://www.donet5.com/Home/Doc?typeId=1226 四.接口要求:请求和响应的主体是JSON结构 2.接下来开始写Restful 服务端，如何实现一个Rest风格的web服务供外部调用。 主要包括以下4点： 定义service的契约 定义URL Routing 实现service 为服务...
Restful Api写法心得之三《返回值篇》
一切都是最好的安排
10-12 6万+
前言 温馨提示：可以订阅我的微信公众号，在手机里看技术文档也很不错哦o(￣︶￣)o！ 这是关于api基础写法的第三篇文章了，这里给下前两篇连接 《路径定义篇》 《参数接收篇》 ，对于本篇文章我们主要说下接口的数据返回值的问题。 格式选择 返回格式目前主流的应该只有XML、JSON两种吧，这里我们不做对比，我们使用JSON作为接口的返回格式。 数据返回格式 数据的返回格式其
WCF RESTful 方式的大数据量限制
lorinzhang
06-18 4792
情景：wcf 使用 RESTful 方式提供服务供 客户端，直接使用 HttpClient 访问 1----当向后台提交 list 数据多条时，或者 wcf 返回 list 数据 多条时，wcf 有限制（即wcf 对 序列化 和反序列化的数量限制） 此限制可以在serviceBehaviors 修改 应配置如下：
restful风格
热门推荐
刘超军的博客
08-24 13万+
概念 一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 URL定义 资源：互联网所有的事物都可以被抽象为资源 资源操作：使用POST、DELETE、PUT、GET，使用不同方法对资源进行操作。 分别对应 添加、 删除、修改、查询。 ...
REST风格
lihongfei110的博客
06-07 346
representational state transfer(表象性状态转变). uri的使用:表示资源id,不同的uri地址应该指向不同资源.单独看这个概念很多系统http请求接口设计已经违反了uri定义 新增商品: product/save 修改商品: product/update 查询商品: product/query 增删查改,对应商品可能是同一个资源,用了3个不同的uri 满足uri: product/manage/{productId},新增商品,修改商品,查询商品访问一个...
Resutful接口规范
weixin_44742328的博客
05-18 2399
一、什么是Resutful Restful就是一个资源定位及资源操作的风格，不是标准也不是协议，只是一种风格，是对http协议的诠释。回顾:之前的URL地址 查询所有的用户:http://localhost:8080/springmvc/user/selectAllUser 按ID查询用户:http://localhost:8080/springmvc/user/selectByUserId?id=12 删除用户:http://localhost:8080/springmvc/user/deleteByUs
RESTful API 介绍
最新发布
08-17
REST (Representational State Transfer) 是一种设计风格，用于创建web API（应用程序编程接口）。RESTful API 使用HTTP标准方法（GET、POST、PUT、...开发者通常会使用像Spring Boot这样的框架来快速构建RESTful API。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值