django rest_framework 部署doc文档

8月前作者：小赖同学啊分类：Toy博客阅读(36) 违法举报

这篇具有很好参考价值的文章主要介绍了django rest_framework 部署doc文档。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

1.背景

在实际开发过程中，前后端分离的项目，是需要将一份完整的接口文档交付给前端开发人员，这样有利于开发速度和开发质量，以及有可能减少协同时间。

2.内容

本项目是以Python+django+rest_framework作为技术框架，在这套框架中，是有自己支持的api文档，现将实现方式整理如下

2.1默认基础框架已经安装成功

2.2在主项目中的url中配置如下代码，基于经验在应用路由也可以实现

django rest_framework 部署doc文档,python,django,python,后端

#在urls.pyh中新增如下代码
  from rest_framework.documentation import  include_docs_urls
  path('docs/', include_docs_urls(title='平台接口文档',
                                    description='接口文档平台'))

2.3等待自启成功后即可完成api文档接口的渲染。前置条件函数和业务逻辑需要自己实现

3.结尾

django rest_framework 部署doc文档,python,django,python,后端

遗留项:

1.想要集成 swagger接口开源框架文章来源地址https://www.toymoban.com/news/detail-798645.html

到了这里，关于django rest_framework 部署doc文档的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：如若内容造成侵权/违法违规/事实不符，请点击违法举报进行投诉反馈，一经查实，立即删除！

分享到：

领支付宝红包赞助服务器费用

Django Rest_Framework（二）

什么时候声明的序列化器需要继承序列化器基类Serializer，什么时候继承模型序列化器类ModelSerializer？看数据是否从mysql数据库中获取，如果是则使用ModelSerializer，不是则使用Serializer drf除了在数据序列化部分简写代码以外，还在视图中提供了简写操作。所以在django原有的dja

2024年02月14日
浏览(27)
django rest_framework 框架动态设置序列化返回的字段

动态修改字段可以使Django rest框架API像graphQL端点一样，只从模型中检索所需的字段。一旦序列化器被初始化，就可以使用.fields属性访问序列化器上设置的字段字典。访问和修改此属性允许您动态修改序列化器。显式地修改fields参数可以帮助您做一些奇怪的事情，例如在运行

2024年02月16日
浏览(42)
Django rest_framework Serializer中的create、Views中的create/perform_create的区别

对于后端来说，前后端分离的方式能让前后端的开发都爽。和所有的爽一样，每爽一次都要付出一定的代价。而前后端分离的代价，就是后端要面对巨量的模块化的功能组件以及这些组件的常规用法与重写复用。有一点经验，关于[Django rest_framework ] Serializer 中的create()、 Vie

2024年02月13日
浏览(26)
rest_framework（3）序列化和反序列化（一）

本系列文章中的上一篇文章：rest_framework.views.APIView 源码解析导入的包序列化器定义 BookView 类 get 方法中是序列化的使用，post 方法中是反序列化的使用 serializers.save() 方法分析 \\\"\\\"\\\" serializer.save() 的源码先看序列化器 BookSerializer ，类中没有 save() 方

2024年02月11日
浏览(29)
基于rest_framework的ModelViewSet类编写登录视图和认证视图

背景：看了博主一抹浅笑的rest_framework认证模板，发现登录视图函数是基于APIView类封装。优化：使用ModelViewSet类通过重写create方法编写登录函数。环境：既然接触到rest_framework的使用，相信已经搭建好相关环境了。编写模型类生成迁移文件迁移数据模型查看ModelViewSet类源

2024年01月17日
浏览(25)
Rest_Framework由浅入深：从CBV到ModelViewSet源码一步步解析

1、Django Rest_Framework介绍 Django REST framework 是一个建立在 Django 基础之上的 Web 应用开发框架，可以快速的开发 REST API 接口应用。在 REST framework 中，提供了序列化器 Serialzier 的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集

2024年02月06日
浏览(33)
Django进阶：DRF(Django REST framework)

DRF 即 Django REST framework 的缩写，官网上说： Django REST framework 是一个强大而灵活的工具包，用于构建Web API 。简单来说：通过DRF创建API后，就可以通过HTTP请求来获取、创建、更新或删除数据(CRUD)。那么为什么要构建API呢？在Django中，我们通过 model-view-template 实现了后端和前

2024年02月11日
浏览(27)
深入探索 Django Rest Framework

这篇文章会详细介绍Django REST Framework的核心组成部分，包括Serializers、ViewSets、Routers、权限和认证系统以及测试和调试工具。文章从基础开始，逐步深入，旨在帮助读者掌握使用Django REST Framework构建复杂API的技能。 Django REST框架，通常简称为DRF，是一个强大而灵活的Web API工具

2024年02月15日
浏览(28)
django rest framework 学习笔记2

注意：该文章部分摘抄之百度，仅当做学习笔记供小白使用，若侵权请联系删除！显示关联表的数据，本示例会显示所有的关联的数据信息读取到的结果器数据关联的为数字，此时需要进行一些操作可以读到正确数据方法1： source=\\\'字段名.关联属性值\\\' 方法2 ：返回其属性值

2024年02月20日
浏览(29)
Django rest framework基本知识

使用pycharm生成Django项目后，会生成工程目录和app目录工程目录下5个文件，settings.py是全局配置相关的 urls.py是路有相关的 app相关的目录 models.py 数据库ORM对应的模型类 serializers.py 序列化与反序列化处理 views.py 根据request进行业务逻辑处理，返回response admin.p

2024年02月09日
浏览(32)