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接口开源框架

相关推荐
山东小木20 分钟前
JBoltAI需求分析大师:基于SpringBoot的大模型智能需求文档生成解决方案
人工智能·spring boot·后端·需求分析·jboltai·javaai·aigs
浪浪山齐天大圣26 分钟前
python数据可视化之Matplotlib(8)-Matplotlib样式系统深度解析:从入门到企业级应用
python·matplotlib·数据可视化
Moonbit31 分钟前
MoonBit 再次走进清华:张宏波受邀参加「思源计划」与「程序设计训练课」
前端·后端·编程语言
RestCloud34 分钟前
一站式数据集成:iPaaS 如何让开发者和业务人员都满意?
前端·后端·架构
F_D_Z37 分钟前
【PyTorch】单对象分割
人工智能·pytorch·python·深度学习·机器学习
编程自留地39 分钟前
18.4 查看订单
python·django·商城
wanzhong233342 分钟前
学习triton-第1课 向量加法
开发语言·python·高性能计算
浊酒南街44 分钟前
Pytorch基础入门4
人工智能·pytorch·python
稻草猫.1 小时前
Java多线程(一)
java·后端·java-ee·idea
dragon_perfect1 小时前
全流程基于Yolov8实现在Label-Studio实现半自动标注,已经把整个流程理清楚,把所有的坑解决。
开发语言·python·yolo·labelstudio