Diango之RESTFul（一）

最新推荐文章于 2024-09-17 23:15:58 发布
最新推荐文章于 2024-09-17 23:15:58 发布
阅读量99 收藏
点赞数
文章标签： python
原文链接：https://blog.csdn.net/weixin_44183759/article/details/106250311?utm_medium=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.nonecase&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.no
版权

 

一、概念
1.1 REST概念
REST（Representation State Transfer）:资源表述性状态转移，是一种结构风格。

​ Resource：“资源”，网络上的一个实体，或者说网络上一个具体信息。它可以是一段文字、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URL（统一资源定位符）指向它，每种资源对应一个特定的URL。要获取这个资源，访问它的URL就可以，因此URL就成了每一个资源地址或独一无二的识别符。（一切皆资源，URL用于资源的唯一标识）。

​ Representation：“资源”是一种信息实体，它可以有多种外在表现形式。我们把资源具体呈现出来的形式，叫做它的“表现层”。比如：文本可以用txt格式、HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用jpg、png、gif格式表现。（1.资源以什么样的表现形式呈现出来2.资源的表现层一般都在请求头信息中体现出来）。

​ State Transfer：访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态变化。互联网通信协议HTTP协议，是一个无状态的协议。这意味着，所有状态都保存在服务端。因此，如果客户端要操作服务器，必须通过某种手段，让服务器端发送“状态转化”（state Transfer）。而这种转化是建立在表现层之上的，所以就是“表现层状态转化”。（1.在客户端和服务器的交互过程中，涉及到状态的转化，我们通过某种手段（ajax、form）让它进行转换）。

​ Uniform Interface:REST要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

​ HTTP1.1协议为例：

​ 7个HTTP方法：GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS

​ HTTP头信息（可自定义）

​ HTTP响应状态码（可自定义）

​ 这些就是HTTP1.1协议提供的统一接口

REST还要求，对于资源的执行操作，其操作语义必须由HTTP消息体之前部分完全表达，不能将操作语义封装在HTTP消息体内部。（1.使用7个HTTP方法来体现对资源的操作，不在url地址中体现） RE

1.2 REST原则
网络上所有事物都被抽象为资源

每个资源都有一个唯一的资源标识符

同一个资源具有多种表现形式（xml,html,json）

对资源的操作不会改变资源标识符

所有的操作都是无状态的

1.3 RESTful
restful:遵守了rest原则的web服务。

理解：restful与rest相比，多了一个ful, 就英语层面来说是一个形容词，restful翻译为中文为： “rest式的” , 是rest式的什么呢？答案是 rest式的应用，rest风格的web服务也是rest式的应用，rest式的web服务是一种ROA(The Resource-Oriented Architecture)(面向资源的架构)，ROA听起来很高大上有没有。

两者联系与区别： restful是由rest派生出来的。

1.4 API
    API是Application Programming Interface（应用程序接口）的缩写，它是拿来描述一个类库的特征或是如何去运用它。 
1
​ 系统的接口：很多情况下，需要把系统功能作为服务暴露给外部的其他应用使用或者给移动端使用，就需要把系统中的服务作为 接口暴露出去，一般分为公共接口（发短信、天气预报）和私用接口（公司内部使用）。

1.5 REST API
    基于RESTful架构的一套互联网分布式的API设计理论.         
1
1. 6 到底什么是RESTful架构
每一个URL代表一种资源
客户端和服务器之间，传递这种资源的某种表现层
客户端通过HTTP动词，对服务端资源进行操作，实现“表现层状态转换”
二、RESTFul Api设计
2.1 协议
API与用户的通信协议，通常使用HTTP(S)协议。

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

http://api.rock.com

如果确定API很简单，不会有大规模扩充，可以考虑放在主域名之下。

http://www.rock.com/api/

2.3 版本
应该将API的版本号放入URL。

http://api.rock.com/v1/

也有做法是将版本号放在HTTP的头信息中，但不如放在URL中方便和直观。GITHUB是这么搞的。

2.4 路径（Endpoint）
路径又称“终点”（endpoint）,表示API的具体网址。

在RESTFul架构中，每个网址代表一种资源（Resource）,所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的“集合”（collection），所以API中的名词也应该使用复数。

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

HTTP常用动词

GET（select）：从服务器获取资源（一项或多项）

POST（create or update）:在服务器新建资源

DELETE（delete）:从服务器删除资源

PUT（update）:在服务器更新资源（客户端提供改变后的完整资源）。PUT更新整个对象

PATCH（update）:在服务器更新资源（客户端提供改变属性【补丁】）。PATCH更新个别属性

HEAD：获得一个资源的元数据，比如一个资源的hash值或者最后修改日期

OPTIONS：获得客户端针对一个资源能够实施的操作（获取该资源的api（能够对资源做什么操作的描述））。

动作示例

GET zoos/：列出所有动物园
POST zoos/:新建一个动物园
GET zoos/ID:获取某个指定动物园的信息
PUT zoos/ID:更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH zoos/ID:更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE zoos/ID:删除某个动物园
GET zoos/ID/animals：列出某个指定动物园的所有动物
2.6 过滤信息（Filtering）
如果记录数量过多，服务器不可能将它们返回给用户。API应该提供参数，过滤返回结果。

?limit=10
?offset=10
?page=2&per_page=20
?sorted=name&order=desc
student_id=id
参数设计允许存在冗余，即允许API路径和URL参数偶尔有重复，比如： GET /students/id和?student_id=id

2.7 状态码
服务器向用户返回的状态码和提示信息，常见的有以下一些地方。

200 OK -[GET]：服务器成功返回用户请求的数据
201 CREATE-[POST/PUT/PATCH]：用户新建或修改数据成功
202 Accepted-[*]:表示一个请求已经进入后台排队（异步任务）
204 No CONTENT-[DELETE]:表示数据删除成功
400 INVALID REQUEST-[POST/PUT/PATCH]：用户发出请求有错误
401 Unauthorized -[*]:表示用户没有权限（令牌，用户名，密码错误）
403 Forbidden-[*]:表示用户得到授权，但是访问是被禁止的
404 Not Found-[*]:用户发出的请求针对的是不存在的记录
406 NOT Acceptable-[8]:用户请求格式不可得
410 Gone-[GET]:用户请求的资源被永久移除，且不会再得到
422 Unprocesable entiy-[POST/PUT/PATCH]:当创建一个对象时，发生一个验证错误
500 INTERNAL SERVER EROR-[*]:服务器内部发生错误
2.8 错误处理
如果状态码是4xx，就应该向用户返回出错误信息。一般来说，返回的信息中将error作为键名

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

GET /collection:返回资源对象的列表（数组、集合）
GET /collection/id:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/id:返回完整的资源对象
PATCH /collection/id:返回完整的资源对象
DELETE /collection/id:返回一个空文档

 

 

 

 

 

 

 

 

 

图文详情：

https://blog.csdn.net/weixin_44183759/article/details/106250311?utm_medium=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.nonecase&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.nonecase

qq_36582955
关注
Django-restful
baisansui的博客
11-23 1939
一、什么是restful？ 简单的说：RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构。 先看REST是什么意思，英文Representational state transfer 表述性状态转移 其实就是对 资源 的表述性状态转移。 （什么是表述性：就是指客户端请求一个资源，服务器拿到的这个资源，就是表述） 资源的地址 在web中就是URL （统一资源标识符） 资源是REST系统的核心概念。 所有的设计都是以资源为中心 结合项目怎么识别资源 1.商品加入购物车 购物车
使用 Flask 或 Django 开发 RESTful API
qq_23926101的博客
04-04 335
RESTful API是目前比较流行的一种API设计风格，它提供了一系列的面向资源的接口，便于客户端和服务器之间的通信。在本文中，我们将介绍如何使用Flask和Django这两个Python框架来开发RESTful API，并给出相应的学习代码。
使用Django开发RESTful API-从基础到高级
一键难忘的博客
08-18 2638
在本教程中，我们详细探讨了如何使用Django构建一个RESTful API。我们从安装和设置环境开始，逐步讲解了如何设计和实现API的各个部分，包括序列化、视图、权限和认证、版本控制，以及如何测试和部署API。Django REST framework为构建RESTful API提供了强大的工具和灵活的架构，适合各种复杂度的应用开发。通过学习和实践，您将能够构建出功能强大、性能卓越的API，为您的应用提供可靠的后端支持。
Django使用Restful框架Framework教程
Pert的博客
11-06 1319
安装包 pip install djangorestframework -i https://pypi.tuna.tsinghua.edu.cn/simple some-package pip install markdown -i https://pypi.tuna.tsinghua.edu.cn/simple some-package # Markdown support for the browsable API. pip install django-filter -i https://pyp.
python django restful_利用Django实现RESTful API(一)
weixin_39789101的博客
11-29 308
RESTful API现在很流行，这里是它的介绍 理解RESTful架构和 RESTful API设计指南.按照Django的常规方法当然也可以实现REST，但有一种更快捷、强大的方法，那就是 Django RESTframework.它是python的一个模块，通过在Django里面配置就可以把app的models中的各个表实现RESTful API。下面是实现方法：一、安装配置pip inst...
【Django】RESTful API接口设计风格
python全栈
06-27 862
它是一种web软件结构的API开发风格，注意它仅仅只是代表着一种风格，并不代表着约束、标准。尽量使⽤https协议，使⽤专属域名来提供API服务，并在URL⾥标注api版本，如下 二、 URI(统⼀资源标识符) 在RESTful架构中，每个⽹址代表⼀种资源（resource），这个⽹络地址就是URI(uniform resource identifier), 有时也被称为URL(uniform resource locator)。因为URI对应⼀种资源，所以⾥⾯不能有动词，只能有名词。⼀般来说，数据库中的表
使用Django开发后端RestFul接口服务
Salted fish in hand, I have the world.
06-29 338
现在AI开发正火热着，有些服务接口使用Python来提供服务可能比SpringBoot更方便快捷，这里记录下使用Django开发RestFul接口服务的过程。安装Django执行命令`pip install django`即可。为了提高下载速度，可以后面加参数-i https://pypi.tuna.tsinghua.ed...
2024年Python最新Python用Django写restful api接口_django resultful api
2401_84584763的博客
05-01 906
Python崛起并且风靡，因为优点多、应用领域广、被大牛们认可。学习 Python 门槛很低，但它的晋级路线很多，通过它你能进入机器学习、数据挖掘、大数据，CS等更加高级的领域。Python可以做网络应用，可以做科学计算，数据分析，可以做网络爬虫，可以做机器学习、自然语言处理、可以写游戏、可以做桌面应用…Python可以做的很多，你需要学好基础，再选择明确的方向。这里给大家分享一份全套的 Python 学习资料，给那些想学习 Python 的小伙伴们一点帮助！
Django实现RESTful风格增删改查代码
NeilNiu
02-19 683
RESTFul风格的增删改查接口 1、获取所有信息 创建model from django.db import models # Create your models here. class Book(models.Model): name = models.CharField(max_length=20) price = models.IntegerField() pub_date = models.DateField() class BookInfo(mode.
django使用二——restful框架使用
LiXueFu727224204的博客
12-29 522
django中restful接口开发
Django的restful用法（自带的增删改查）
01-27
Django的RESTful框架是基于Python的Django Web框架构建API的一种强大工具，它遵循REST（Representational State Transfer）架构风格，使得开发高效、简洁且易于理解的API变得容易。REST是一种网络应用程序的设计风格...
基于Django的RESTful学习项目设计源码
04-17
本项目是基于Django框架开发的RESTful学习项目设计源码，主要使用HTML、CSS、JavaScript和Python进行开发。...该项目采用了Django ...项目结构清晰，代码注释详尽，适合用于学习和研究Django RESTful API的开发与应用。
django_restful.7z
12-25
标题 "django_restful.7z" 暗示着这个压缩包包含与Django Restful相关的资源，可能是一个使用Django框架开发的RESTful API项目。Django是Python编程语言中的一个流行Web开发框架，而Django Restframework（通常简称...
[Python数据可视化]Plotly Express: 地图数据可视化的魅力
最新发布
William数据分析的博客
09-17 922
在数据分析和可视化的世界中，地图数据可视化是一个强大而直观的工具，它可以帮助我们更好地理解和解释地理数据。Python 的 Plotly Express 库提供了一个简单而强大的方式来创建各种地图。本文将通过一个简单的示例，展示如何使用 Plotly Express 来创建一个交互式的地图，并探讨其在地图数据可视化方面的应用。
Tcl lnit error: Can’t find a usable init.tcl in the following directories 问题解决
梦想闹钟
09-15 559
实际研究后发现，其实py2exe已经把打包需要的lib放在dist文件夹下了，但是打包后的程序运行后却没有去lib下找，而是去找系统自带的环境变量里找，所以找不到。这个问题出现在我用py2exe打包了一个包含tkinter的图形化界面，在当前电脑上运行无问题，在移动到新电脑上后提示报错、getcwd用于获取当前工作目录绝对路径，在设置环境的变量的时候它用的是绝对路径-所以也导致了在当前电脑上能用而移动后不能用。解决方法是在你的程序里重新设置下环境变量，而且是用相对路径的形式。
Java企业面试题3
m0_74972727的博客
09-15 868
1. break和continue的作用(智*图) break：用于完全退出一个循环（如 for, while）或一个 switch 语句。当在循环体内遇到break语句时，程序会立即跳出当前循环体，继续执行循环之后的代码。 continue：用于跳过当前循环体中剩余的部分，并开始下一次循环。如果是在 for 循环中使用continue，则会直接进行条件判断以决定是否执行下一轮循环。 2. if分支语句和switch分支语句的异同之处(智*图) 相同点：都是用来根据不同的条件执行不同的代码块。
Python——俄罗斯方块
2302_81225694的博客
09-14 2426
这段代码使用了Pygame库来实现游戏的图形界面，通过键盘控制方块的移动和旋转。游戏循环不断更新方块的位置和网格状态，并绘制在屏幕上。在方块达到底部或无法继续移动时，判断是否有满行，并清除满行的方块。游戏会根据方块的状态和移动情况不断更新，直到无法继续下落为止，游戏结束。俄罗斯方块游戏是一款经典的益智游戏，通常使用编程语言Python来实现。请注意，这只是一个简单的示例，可能还有一些功能和优化方面的改进。您可以根据自己的需求进行修改和扩展。
文档内容识别系统源码分享
xuehaishijue的博客
09-17 1671
数据集信息展示在当今信息爆炸的时代，文档内容识别系统的有效性和准确性愈发重要。为了提升YOLOv8在文档内容识别任务中的表现，我们采用了名为“FULL 2”的数据集进行训练和评估。该数据集专为文档图像的多样性和复杂性而设计，涵盖了多种类别的文本元素，使其成为优化深度学习模型的理想选择。
2024.9.16 day 1 pytorch安装及环境配置
m0_58285219的博客
09-16 645
pytorch安装及环境配置
使用Django构建RESTful API与实时应用
在Django中，可以使用Django Rest Framework这样的库来轻松构建RESTful API。通过这些API，前端和后端可以更好地分离，实现前后端的解耦，同时支持多种客户端，如移动应用或JavaScript应用。 2. **WebSockets**：...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值