Python - Django框架 - REST API开发

最新推荐文章于 2024-03-20 08:35:10 发布
VIP文章 最新推荐文章于 2024-03-20 08:35:10 发布
阅读量641 收藏 4
点赞数 3
分类专栏： 开发语言-Python 文章标签： django rest api rest framework django rest
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chenyunqiang/article/details/102710090
版权

1. Web应用模式

1.1 前后端不分离

在这里插入图片描述

  • 在前后端不分离的应用模式中，前端页面看到的效果都是由后端控制，由后端渲染页面或重定向，也就是后端需要控制前端的展示，前端与后端的耦合度很高。
  • 应用场景分析
    这种应用模式比较适合纯网页应用，但是当后端对接App时，App可能并不需要后端返回一个HTML网页，而仅仅是数据本身，所以后端原本返回网页的接口不再适用于前端App应用，为了对接App后端还需再开发一套接口。
1.2 前后端分离

在这里插入图片描述

  • 在前后端分离的应用模式中，后端仅返回前端所需的数据，不再渲染HTML页面，不再控制前端的效果。至于前端用户看到什么效果，从后端请求的数据如何加载到前端中，都由前端自己决定，网页有网页的处理方式，App有App的处理方式，但无论哪种前端，所需的数据基本相同，后端仅需开发一套逻辑对外提供数据即可。
  • 在前后端分离的应用模式中 ，前端与后端的耦合度相对较低。
  • 在前后端分离的应用模式中，我们通常将后端开发的每个视图都称为一个接口，或者API，前端通过访问接口来对数据进行增删改查。

2. RESTful设计方法

2.1 域名

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

https://api.example.com

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

https://example.org/api/
2.2 版本

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

http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。
因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见Versioning REST Services）：

Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
2.3 路径

路径又称"终点"（endpoint），表示API的具体网址，每个网址代表一种资源（resource）

(1) 资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。

举例来说，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

对于一个简洁结构，你应该始终用名词。 此外，利用的HTTP方法可以分离网址中的资源名称的操作。

GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PATCH（或）PUT /products/4 ：将更新产品 4
(2) API中的名词应该使用复数。无论子资源或者所有资源。

举例来说，获取产品的API可以这样定义

获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products
2.4 HTTP动词

对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

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

还有三个不常用的HTTP动词。

PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子:

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园（上传文件）
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
2.5 过滤信息

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

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
2.6 状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

200 OK - [GET]：服务器成功返回用户请求的数据
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
状态码的完全列表参见这里或这里。
2.7 错误处理

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

{
   
	error: "Invalid API key"
}
2.8 返回结果

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

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection
最低0.47元/天 解锁文章
孤独的侠客
关注
  • 3
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Django 创建 REST API
haiiiiiyun的博客
03-25 406
REST API 设计基础 REST API 操作与 HTTP 方法的关系 请求目的 | HTTP 方法 | 相应的 SQL ------------------------------------|-----------| 创建一个资源 | POST | INSERT 读取一个现有资源 ...
Python-drfchaos用于测试DjangoRest框架API的装饰器工具集
08-12
drf-chaos-用于测试Django Rest框架API的装饰器工具集
使用Django 中创建一个 API
最新发布
weixin_74923758的博客
03-20 813
Django REST framework（简称DRF）是一个强大灵活的 Python 工具包，用于在 Django 中构建 Web API。它提供了一套工具和库，帮助开发人员为他们的 Django Web 应用程序创建 API。使用 Django REST framework，开发人员可以轻松地序列化/反序列化数据，处理身份验证、权限和版本控制，并创建可浏览的 API。
PythonDevTest:使用rest api测试python-django应用
05-08
中级Python开发人员（MedTech） 此应用程序是“勿忘我”应用程序团队中开发人员的中级职位的一项测试任务。 结果必须作为派生链接发送到 要求 使用Django框架和任何DBMS编写和部署Python Web应用程序。 应用程序是一项简单的服务，可收集客户信息。 它应该包括几个部分： 联系表 新的联系人创建表单 联系人编辑表 联系人删除表 联系人视图表格 基本功能 联系表 应用程序启动屏幕。 它显示数据库（DB）中的所有联系人。 该表单必须包含分页和服务器端搜索。 1页=最多10个条目。 同时，页数取决于数据库中的记录数和搜索结果。 搜索应过滤表中的记录数和页数。 新的联系人创建表单 将新联系人保存到数据库。 必须在客户端和服务器端实现对“ Email和“ Phone字段的验证。 联系人编辑表 此表单使您可以编辑和保存数据库中的联系人。 必须在客户端和服务器端实现对“ E
ra-data-django-rest-framework:Django REST框架的react-admin数据提供程序
04-29
ra-data-django-rest-framework 数据和身份验证提供程序。 ra-data-django-rest-framework包括后端和客户端示例应用程序以及测试。 安装 npm install ra-data-django-rest-framework 用法 import drfProvider from 'ra-data-django-rest-framework' ; const dataProvider = drfProvider ( "/api" ) ; 特征 排序 分页 筛选 验证 排序 支持订购 。 分页 当前支持使用分页。 默认的PageNumberPagination page_size_query_param设置为None ，可以设置每页行数，即： from rest_framework . pagination import PageNumb
django-rest-framework-api-key：使用Django REST框架对Web API进行身份验证的额外层
02-04
django-rest-framework-api-key 验证使用Django REST Framework创建的Web API 支持 Python（2.7、3.3、3.4、3.5） Django（1.8、1.9、1.10） Django Rest框架（3+） 安装 使用pip安装： pip install drfapikey 将“ rest_framework_api_key”添加到您的INSTALLED_APPS设置中： INSTALLED_APPS = ( ... 'rest_framework_api_key', ) 最后，在django设置下设置djang
Python web实战之Django 的 RESTful API 设计详解
Rocky006的博客
08-08 2010
​ API是应用程序编程接口（Application Programming Interface）的缩写。它是一种定义了不同软件组件之间交互方式的规范。API允许不同的应用程序之间进行通信和数据交换，使得开发者能够利用其他应用程序提供的功能和数据，而无需了解其内部实现细节。 在Web开发中，API通常是用于构建和访问Web服务的一种方式。通过API，开发者可以通过HTTP请求发送和接收数据，从而实现不同应用程序之间的数据传输和交互。
Django3（四）Django REST framework（一）RESTful API
野猫炫的博客
09-22 1025
这种应用模式比较适合纯网页应用。在前后端分离的应用模式中，后端仅返回前端所需的数据，不再渲染HTML页面，不再控制前端的效果。至于前端用户看到什么效果，从后端请求的数据如何加载到前端中，都由前端自己决定，网页有网页的处理方式，App有App的处理方式，但无论哪种前端，所需的数据基本相同，后端仅需开发一套逻辑对外提供数据即可。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。
Django REST Framework——1. API和RESTful接口规范
花城的博客
12-12 1333
文章目录一、Web架构1.1 前后端混合架构（前后端不分离）1.2 前后端分离架构二、API（Application Programming Interface，应用程序编程接口）三、RESTful接口规范3.1 什么是RESTful规范3.2 RESTful API 设计指南安全保障表识API版本控制路径HTTP动词，即请求方法（method）过滤HTTP状态码1xx（信息）：通信传输协议级信息2xx（成功）：表示客户端的请求已成功接受3xx（重定向 ）：表示客户端必须执行一些其他操作才能完成其请求4xx
restful开发接口案例
路在脚下
03-24 3326
使用Django开发REST 接口 我们以在Django框架中使用的图书英雄案例来写一套支持图书数据增删改查的REST API接口，来理解REST API的开发。 在此案例中，前后端均发送JSON格式数据。 # views.py from datetime import datetime class BooksAPIVIew(View): """ 查询所有图书、增加图书 ...
基于django的rest api快速开发（只提供一个接口服务）
brains11的博客
03-02 1万+
需求:目前我们有一个后台的python脚本和前台的页面，我们需要提供一个类似tomcat的服务，来使前台的一个请求，通过我们搭建的服务去调用python模型，并最终将处理的结果返回给前台。一：搭建django rest api 环境首先我们需要有python环境,这是基础，配置好python环境后就可以开始下面的操作了# 创建虚拟环境文件夹mkdir tutorialcd tutorial# 创建...
order-management-system-api-django_rest
04-22
订单管理系统API指南 Projet设置 从灯具加载产品数据 python manage.py loaddata products.json 根据数据库数据创建模型夹具 python manage.py dumpdata orders.Product > fixtures.json 文献资料 昂首阔步，ReDoc 您可以使用Swagger或ReDoc探索项目端点： http://127.0.0.1:8000/swagger/ http://127.0.0.1:8000/redoc/ 可浏览的API 您可以使用Django Rest Framework提供的Browsable API来请求端点。 尝试获取订单列表，例如： http://127.0.0.1:8000/api/v1/orders/
利用Django实现RESTful API(一)
我思故我在的博客
08-31 4707
利用Django实现RESTful API(一) 　　RESTful API现在很流行，这里是它的介绍 理解RESTful架构和 RESTful API设计指南.按照Django的常规方法当然也可以实现REST，但有一种更快捷、强大的方法，那就是 Django REST framework.它是python的一个模块，通过在Django里面配置就可以把app的models中的各个表实
Django(9)|基于reseful-api风格的Django-framework
不愿意透露姓名的网友
06-22 1337
restful API 是一种符合rest风格的接口，rest是一种架构风格，采用http协议。
【Python】利用Django搭建REST风格API后台服务（一）
热门推荐
tunm的小笔记
07-25 2万+
原文地址 简介 最近在开发一款安卓应用，需要用到后台。本来想使用springboot来搭建一个微服务，不过后来发现Django的REST框架实际上也不错，由于这个项目的开发周期是两个礼拜不到，所以没有太多的时间。于是便选择了Django作为应用的后台，合理的使用REST framework这个插件可以帮我们省去非常多的时间，用相对比较少的代码量来实现对数据增删改查的一系列API函数，对短周...
Python利用Django 构建Rest Api: 快速入门教程
python爬虫人工智能大数据
01-27 723
点击上方“测试开发技术”，选择设为“设为星标”优质文章，第一时间送达！近期荐文：年底特辑：新一代测试平台开源实战项目Python 3+Django 3 结合Vue.js框架构建前后端分离...
使用Django完成接口API的开发（REST）
Seven597的博客
11-27 1875
使用Django实现REST urls.py 代码展示 from django.conf.urls import url from . import views urlpatterns = [ # 列表视图的路由 url(r'^books/$', views.BookListView.as_view()), # 详情视图的路由 url(r'^books/(?P<pk>\d+)/$',views.BookDetailView.as_view()), ] vie
django开发api接口
qq_17375491的博客
10-28 5755
环境准备： python3.8 django 3.0.6 pycharm 2020.1 1、准备工作 pip3 install django 2、开始代码 2.1、settiong文件配置 INSTALLED_APPS增加自己的app名称 ```python INSTALLED_APPS = ['small_api',] 需要部署到服务器上需要更改该配置，若不部署，则不用更改 ```python ALLOWED_HOSTS = ['*'] 2.2、增加urls文件配置 ```urlpatterns
【007】- Django Rest API简介
zhangxiongcolin的专栏
02-25 320
本篇接上篇内容，我们学习Django视图。学习之前，我们首先声明，我们主要以目前比较流行的前后端分离思想为主。本篇只是进行一个演示，后续我们将会介绍专门的Rest API方式—Rest Framework。 在前面我们在models.py中定义了两个模型类，分别为User和Role class User(models.Model): """ 用户模型类 """ SEX_CHOICE...
python使用django框架创建API接口
06-06
好的，下面是使用Django框架创建API接口的步骤： 1. 创建Django项目： 使用Django命令行工具创建一个新的Django项目： ``` django-admin startproject myproject ``` 2. 创建Django应用： 使用Django命令行工具创建一个新的Django应用： ``` python manage.py startapp myapp ``` 3. 安装Django REST framework： 使用pip安装Django REST framework： ``` pip install djangorestframework ``` 4. 配置Django REST framework： 在Django项目的settings.py文件中添加以下配置： ```python INSTALLED_APPS = [ # ... 'rest_framework', ] REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.AllowAny', ], 'DEFAULT_AUTHENTICATION_CLASSES': [ 'rest_framework.authentication.SessionAuthentication', 'rest_framework.authentication.TokenAuthentication', ], } ``` 这将启用Django REST framework，并为API添加身份验证和权限。 5. 定义模型： 在Django应用的models.py文件中定义一个模型： ```python from django.db import models class Book(models.Model): title = models.CharField(max_length=100) author = models.CharField(max_length=100) price = models.DecimalField(max_digits=5, decimal_places=2) def __str__(self): return self.title ``` 这个模型将创建一个Book对象，包括书名、作者和价格。 6. 创建序列化器： 在Django应用的serializers.py文件中创建一个序列化器： ```python from rest_framework import serializers from .models import Book class BookSerializer(serializers.ModelSerializer): class Meta: model = Book fields = '__all__' ``` 这个序列化器将Book对象转换为JSON格式。 7. 创建视图： 在Django应用的views.py文件中创建一个视图： ```python from rest_framework import generics from .models import Book from .serializers import BookSerializer class BookList(generics.ListCreateAPIView): queryset = Book.objects.all() serializer_class = BookSerializer ``` 这个视图将查询所有的Book对象，并使用BookSerializer序列化器将它们转换为JSON格式。 8. 添加URL： 在Django应用的urls.py文件中添加一个URL： ```python from django.urls import path from .views import BookList urlpatterns = [ path('books/', BookList.as_view(), name='book-list'), ] ``` 这个URL将请求发送到BookList视图。 9. 运行Django项目： 使用Django命令行工具运行Django项目： ``` python manage.py runserver ``` 现在，你可以使用REST客户端访问你的API接口，例如使用浏览器访问http://127.0.0.1:8000/books/，将返回所有的Book对象的JSON格式。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值