5.2Restful API接口设计风格 关键点： a.url地址尽量使用名词，不要使用动词； b.请求url地址采用不同的请求方式执行不同的操作；(POST新增/GET获取/PUT修改/DELETE删除...5.5.2视图基类 5.5.2.1APIView 是View类的子类，在View类的基础上添加了一些额外的功能。.../update/retrieve/destroy 2.在进行url配置的时候，要指明请求地址的请求方式和视图集中处理函数之间的对应关系。...5.6.4视图集中添加额外的处理方法 1.直接在视图集定义额外的处理方法即可 2.在进行url配置的时候也要指定请求地址请求方式和处理函数之间的对应的关系。...返回latest操作使用的查询集 else: # 返回其他操作所使用的查询集 5.6.6路由Router 作用 配合视图集进行使用，动态生成视图集中处理函数的url配置项。
rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。...HyperlinkedModelSerializer 在Web API设计中，一般有以下几种方式来表示实体之间的关系： 主键 超链接 关系实体（the related entity），唯一标识符字段（a...DRF支持以上所有方式，这里我们用DRF的HyperlinkedModelSerializer来实现真正的RESTful。...，SnippetSerializer和UserSerializer的url字段默认指向的是'{model_name}-detail' url pattern，这是DRF定义的，在示例中就是'snippet-detail...', 'PAGE_SIZE': 10 } 东方说 我之前是在学SpringBoot的时候了解过RESTful API的超链接API，文章开头的那一段介绍就是当时写的笔记，DRF提供了HyperlinkedModelSerializer
3.2见识DRF的魅力 我们仍以在学习Django框架时使用的图书英雄为案例，使用Django REST framework快速实现图书的REST API。 3.2.1....路由Router：动态生成视图集中API处理函数的url地址的配置项 from booktest import views from rest_framework.routers import DefaultRouterurlpatterns...= [ ... ] # 路由Router：动态生成视图集中API处理函数的url地址的配置项 router = DefaultRouter() # 可以处理视图的路由器 router.register...:DRF框架中所有序列化器的父类，定义序列化器类时，可以直接继承此类 # serializers.ModelSerializer：是Serializer的子类，在父类基础上，添加了一些功能 class...heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True) 2）使用指定的序列化器将关联对象进行序列化（字典套字典的显示方式
DRF视图集路由 对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由列表信息。...viewset 视图集 basename 路由名称的前缀，一般和prefix一致。...，可以使用下面两种方法中的任意一种。...的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。...参考资料： 美多商城课程资料 DRF的Pagination文档
Serializer 在 DRF 中负责：序列化：将模型实例/Python 对象 → 转换为 JSON等格式反序列化：将客户端传入的数据 → 转换为 Python 对象 → 再保存到数据库数据验证：检查输入数据是否符合业务规则...= SlugRelatedField(slug_field='name', queryset=Category.objects.all())HyperlinkedIdentityField生成当前对象的超链接...基础扩展字段：处理特定格式数据（如金额用 DecimalField，URL 用 URLField）关系型字段：处理模型关联（如 SlugRelatedField 替代 PrimaryKeyRelatedField...所有字段 password = CharField(write_only=True) label 字段的友好名称...数据验证5.1 三层验证机制字段级别验证：单个字段的合法性对象级别验证：多个字段的关系检查自定义验证器：可复用的验证逻辑5.2 验证示例class OrderSerializer(serializers.Serializer
在前后端分离的应用模式中，我们通常将后端开发的每个视图都称为一个接口，或者API，前端通过访问接口来对数据进行增删改查....RESTful RESTful 特点 get 查询 post 增加 put 修改 delete 删除 每个URL代表一种资源 客户端和服务器之前,传递这种资源的耨中表现层 客户端同坐HTTP动词,对服务器端资源进行操作...特点: 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化； 提供丰富的类视图,Mixin扩展类,简化视图的编写 丰富的定制层级:函数视图...,类视图,视图集合到自动生成API,满足各种需要 多种身份认证和权限认证的支持 内置限流系统 直观的API web 界面 可扩展性,插件丰富 创建 REST framework 工程 安装DRF pip...serializers.IntegerField(label='评论量', required=False) image = serializers.ImageField(label='图片', required=False) 视图中使用
什么是视图集？视图集是 DRF 提供的用于统一管理多个相关视图逻辑的类。...DRF 的路由器（如 DefaultRouter 和 SimpleRouter）通过以下机制自动生成 URL：视图集的标准化方法undefined视图集（如 ModelViewSet）定义了标准化的方法...：DRF 的路由器通过预定义的规则（如 list 对应 GET /users/），结合视图集的方法检测，动态生成 URL。...视图集中 @action 装饰器的使用@action 是 DRF 中用于在视图集（ViewSet）中定义自定义动作的核心装饰器，可以将任意方法暴露为 API 端点。下面通过更多场景详细说明其用法。...methods: 允许的 HTTP 方法（如 ['get', 'post']）。url_path: 自定义 URL 路径（默认用方法名）。url_name: 路由名称（用于反向解析）。
）来提供更加灵活的请求解析和使用内容协商来确定返回给客户端的正确内容类型。...DFR还提供了两个可用于编写API视图的包装器（wrappers）： 用于基于函数视图的@api_view装饰器； 用于基于类视图的APIView类。...接下来，我们将使用APIView 类进行视图开发。...在apiTest/project.py中添加以下代码： 显示-URLs 为了客户端能够访问开发完成的接口（即url与视图的映射），在apiTest/urls中添加如下代码： 如此就可以通过 http...后记 DRF 也提供了认证与权限、超链接API等等功能，大家可以通过查看官方文档继续学习~ 官网地址：https://www.django-rest-framework.org/
资源就是网络上的一个实体，一段文本，一张图片或者一首歌曲。资源总是要通过一种载体来反应它的内容。JSON是现在最常用的资源表现形式。 统一接口。...', 'name'] 上面的代码直接继承了ModelSerializer，通过Meta类的model属性指定要序列化的模型以及fields属性指定需要序列化的模型字段，稍后我们就可以在视图函数中使用该类来实现对...在Group和User中，我们使用的是HyperlinkedModelSerializer的超链接关系。您也可以使用主键和各种其他关系，但是超链接是很好的RESTful设计。...编写视图函数 DRF框架支持两种实现数据接口的方式，一种是FBV（基于函数的视图），另一种是CBV（基于类的视图）。代码如下所示。...bpmapper实现模型序列化的代码，使用DRF的代码更加简单明了，而且DRF本身自带了一套页面，可以方便我们查看我们使用DRF定制的数据接口，如下图所示。
作者：HelloGitHub-追梦人物 大多数情况下，开发的接口都不是给开发这个接口的人用的，所以如果没有接口文档，别人就无法知道有哪些接口可以调用，即使知道了接口的 URL，也很难知道接口需要哪些参数...完善文档 drf-yasg 毕竟不是使用人工智能开发的，即使是使用人工智能，也很难做到 100% 的正确，毕竟由人类写的代码可能是千变万化的，工具无法预料到所有可能的情况，一旦它遇到无法处理的地方，自动生成的文档就可能出错...基本上没有任何描述信息来说明这个接口的功能。 接口的部分参数也没有描述信息，可能会让接口的使用者无法知道其准确含义。...drf-yasg 支持从视图的 docstring 解析接口对应的描述信息，只要符合指定的格式即可。...，但在全局进行了配置），在解析 list_archive_dates 的参数时，drf-yasg 错误地解析到了从视图集继承来的 PostFilter 和 PageNumberPagination，所以就把这两个类中定义的参数也包含进文档了
DRF框架学习（四） 1.视图集对象的action属性 作用： 获取现在要执行的是哪一种操作。 self.action:是字符串类型，目的是获取所有执行的操作。...urlpatterns += router.urls 注意点： 指定Router生成视图集处理函数url配置项时，提取的参数正则表达式。...lookup_value_regex = '\d+' 2.1视图集额外处理方法url配置项的生成 需要给对应的方法添加action装饰器。...False DefaultRouter与 SimpleRouter的区别是， DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。...10.2自定义异常处理 10.2.1自定义DRF框架异常处理函数 1.自定义异常处理函数 2.设置EXCEPTION_HANDLER配置项 10.2.2详解 可以在DRF框架异常处理函数的基础上，补充一些其他的异常处理
根据视图名称寻找路由，进而拼接成完整URL {'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': 'http://127.0.0.1...Request 常用属性 1） .data –>类似 Django 中的 request.POST 包含了解析之后的文件和非文件数据 包含了对POST、PUT、PATCH请求方式解析后的数据...支持定义的属性： 列表视图与详情视图通用 queryset 列表视图的查询集 serializer_class 视图使用的序列化器 列表视图使用 pagination_class 分页控制类...filter_backends 过滤控制后端 详情页视图的使用 Lookup_field 查询单一数据对象使用的条件字段，默认为‘pk’ Look_url_kwarg 查询单一数据时 url 中的参数关键字名称...视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。
2）返回的时候用到了 HttpResponse这一命令返回响应对象 1.3.2url地址的配置 1.在子应用中的urls.py文件中设置当前子应用中url地址和视图对应关系 urlpatterns =...[ url(r'^url正则表达式$',views.视图函数名) ] 2.在项目总的urls.py文件中包含子应用中的urls.py文件 urlpatterns = [ url(r'^'...1.9.1类视图的使用 1）定义类视图 /register/ class RegisterView(View): def get(self,request): return HttpResponse...()) 1.9.2类视图添加装饰器 使用Django框架提供method_decorator将针对函数视图装饰器添加到类视图的方法上面 # 为全部请求方法添加装饰器 @method_decorator(...站点就可以进行图片上传 2.DRF框架 2.1目的 利用DRF框架快速的实现RestAPI接口的设计 2.2RestfulAPI接口设计风格 关键点 1）url地址尽量使用名词，不要使用动词 2）请求url
DRF(Django RestFramework)是一套基于Django开发的、帮助我们更好的设计符合REST规范的Web应用的一个Django App，所以，本质上，它是一个Django App。...DRF APIView请求流程: ? DRF对django视图配置流程图(个人画) ?...2 解析器组件 (用来解析数据的请求的组件) Django并不能处理请求协议为application/json编码协议的数据 注意: DRF解析器会封装到View中的parsers内,在视图函数被调用时...，获取url及视图类的对应关系 开始绑定视图类和url的对应关系，执行as_view()方法 as_view()方法被执行的时候传递了参数，为字典形式：{ “get”: “retrieve”, “delete...是视图类，执行视图函数时self就指向视图函数的实例对象 等待客户端请求 请求到来，开始执行视图函数，注意，调用视图函数时的方式是view(request)，而如果url带有参数，调用方式为view(request
1.2类视图的两个基类 1.2.1APIView 是View类的子类，在view类的基础上添加了一些额外的功能。...它的作用：比如我们定义了一个视图，没有形参接收传递的参数，那么我们可以使用 self.kwargs从url地址中提取我们需要的数据。...lookup_url_kwarg指定从查询集获取对象时，从url地址中提取的参数的名称。 注意：经常配合Minxin扩展类来使用。...（重要） 2.2注意点 1、视图集中的处理方法不再是以请求方式命名，而是以对应的操作名称（list、create、update、retrieve、destroy） 2、在进行url配置的时候，要指明请求地址的请求方式和视图集中处理函数之间的对应关系...2.4视图集中添加额外的处理方法 1、直接在视图集中定义额外的处理方法即可 2、在进行url配置的时候指定请求地址请求方式和处理函数之间的对应的关系。
DRF的Request对象和Response对象 一旦使用了DRF的视图，那么传入视图的Request对象不在是Django的Request对象，而是DRF封装过后的Request对象。...同样，DRF建议使用封装过的Response来返回HTTP响应，使用该类构造响应对象时，响应的具体数据内容会被转换（render渲染）成符合前端需求的类型。...APIView类的视图设置用于单个视图或视图集的解析器。...相同，只是更换了更正确的名称而已。...无论请求方式是什么，URL中的参数，我们在DRF中总是使用request.query_params来获取。
DRF框架中的英文单词 1. prefix/'prifɪks/前缀，我们在路由配置的时候经常看见这个单词。在flask中，我们可以在设置url的时候为了区别视图，在类似功能的url全部加一个前缀。...15. verbose/vɝ'bos/冗长的；啰嗦的，我们使用verbose_name指明一个易于理解和表述的对象名称。...17. detail/dɪˈtel/详细，我们在展示详情的时候，视图名称通常会用到这个单词。 18. urlpatterns这其实不是一个单词，我们只是将url和patterns（模式）组合了一下。...# 指明该视图在进行序列化或反序列化时使用的序列化器 serializer_class = BookInfoSerializer 23.通用参数： 参数名称 说明 read_only 表明该字段仅用于序列化输出...32. router/'rʊtɚ/路由器，我们指的可不是路由器了，它指的也不是视图函数，而是封装了视图函数和请求的url的映射关系的一个东西。 33.
5, 关系(Relationships)与超链接API(Hyperlinked APIs) 现在，用主键代表我们API之间的关系。在这部分教程，我们会用超链接改善API之间的关系。...代表一种关系可以有很多种方式： 使用主键。 在实体之间使用超链接。 在相关的实体上使用独一无二的slug。 使用相关的实体的默认字符串。 在父表述使用嵌套的实体。 一些自定义的表述。...REST框架支持以上所有方式，都能适应正向或者反向关系，或者就行使用一般的外键一样使用自定义的管理方式。 这种情况下，我们想要在实体之间使用超链接方式。...它只包括一个url字段，使用HyperlinkedIndentityField。 关系使用HyperlinkedRelatedField，而不是PrimaryKeyRelatedField。...我们能使用超链接快速重写现存的序列。
》 《django入门：Admin管理系统及表单》 《django入门：通用视图类重构视图》 《用django写接口（入门篇）》 《用django写接口（优化篇）》 正文 上一部分我们通过基本类重构了...view，那这部分我们继续深入了解下 DRF 的分页，多条件筛选以及 Token 权限认证 接口数据分页 如果说，后台给你返回的数据很多很多，然后又没有做分页(反正我是碰到过)，然后就一直卡在加载界面，...接口分页效果 我们可以看到接口返回的信息还包含了前一页和后一页的 url 是不是很人性化 接口数据多条件筛选 目前我们的接口要查找特定的信息只能通过 id 来查找，这肯定是不够完善的，这部分将设置接口的多条件查询...首先我们需要安装过滤器的模块 pip install django-filter 然后我们需要将过滤器模块到 settings.py 中的 INSTALLED_APPS 进行注册才可以使用。...绑定我们自己的认证类即可返回我们需要的字段值啦~ DRF 的基本内容到这边也基本结束了，希望你能有所收获。
在DRF中，路由器（Router）是一个非常有用的工具，可以帮助我们轻松地定义API的路由，实现快速、可维护的API开发。一、路由器的作用在DRF中，路由器的主要作用是将URL和视图函数绑定在一起。...路由器可以根据视图函数的名称和参数，自动生成URL，并将请求分发到对应的视图函数中。使用路由器可以避免手动编写URL配置的繁琐和容易出错。二、路由器的使用安装DRF在使用路由器之前，需要先安装DRF。...（1）基于视图集在DRF中，视图集是一组视图函数的集合，可以实现类似于CRUD的操作。...此时，路由器会自动根据BookViewSet的名称和默认的操作（list、create、retrieve、update、partial_update和destroy），生成如下的URL：HTTP MethodURLActionGET...router.register(r'hello', HelloView.as_view(), basename='hello')在这个例子中，我们将HelloView注册到了/hello的URL上。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
对象存储
腾讯会议
云直播
