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

相关推荐
闲人编程2 小时前
Python在网络安全中的应用:编写一个简单的端口扫描器
网络·python·web安全·硬件·端口·codecapsule·扫描器
星释4 小时前
Rust 练习册 :Leap与日期计算
开发语言·后端·rust
Mr_Xuhhh5 小时前
GUI自动化测试--自动化测试的意义和应用场景
python·集成测试
2301_764441336 小时前
水星热演化核幔耦合数值模拟
python·算法·数学建模
循环过三天6 小时前
3.4、Python-集合
开发语言·笔记·python·学习·算法
Q_Q5110082856 小时前
python+django/flask的眼科患者随访管理系统 AI智能模型
spring boot·python·django·flask·node.js·php
码事漫谈8 小时前
C++死锁深度解析:从成因到预防与避免
后端
SunnyDays10118 小时前
如何使用Python高效转换Excel到HTML
python·excel转html
码事漫谈8 小时前
智能体颠覆教育行业:现状、应用与未来展望调研报告
后端
蓝-萧8 小时前
【玩转全栈】----Django基本配置和介绍
java·后端