django rest_framework 部署doc文档

1.背景

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

2.内容

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

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

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

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

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

3.结尾

遗留项:

1.想要集成 swagger接口开源框架

相关推荐
qiuchangyong1 小时前
TypeError: only size-1 arrays can be converted to Python scalars
python·numpy
Mopes__3 小时前
Python | Leetcode Python题解之第421题数组中两个数的最大异或值
python·leetcode·题解
reasonsummer4 小时前
【教学类-52-11】20240919动物数独(4宫格)1图、2图、6图、有答案、无答案 组合版18套
python
Amo Xiang4 小时前
Python练习宝典:Day 1 - 选择题 - 基础知识
开发语言·python
软件开发技术深度爱好者4 小时前
Python青少年简明教程目录
开发语言·python
西贝爱学习4 小时前
python新手的五个练习题
开发语言·python
小筱在线4 小时前
在SpringCloud中实现服务间链路追踪
后端·spring·spring cloud
计算机学姐4 小时前
基于SpringBoot+Vue的高校门禁管理系统
java·vue.js·spring boot·后端·spring·intellij-idea·mybatis
大熊程序猿4 小时前
go 安装依赖超时
开发语言·后端·golang
谛凌4 小时前
【Python123题库】#绘制温度曲线 #XRD谱图绘制 #态密度曲线绘制
开发语言·python·python123·python题库