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

相关推荐
IT_陈寒20 小时前
React的这个渲染问题连官方文档都没说清楚
前端·人工智能·后端
金銀銅鐵21 小时前
[Python] 扩展欧几里得算法
python·数学·算法
Duckdblab21 小时前
DuckDB 性能调优终极指南:打造闪电般的分析体验
python
葫芦和十三21 小时前
图解 MongoDB 15|journal 与持久化:写入怎么不丢,崩溃怎么恢复
后端·mongodb·面试
葫芦和十三21 小时前
图解 MongoDB 16|压缩:snappy、zstd 和 zlib 的取舍
后端·mongodb·面试
苍何21 小时前
终于找到免费开源TTS模型,克隆声音不要钱,本地电脑也能跑
后端
用户5936087414021 小时前
Spring AI 集成 DeepSeek 原生供应商并实现think模式
后端
追逐时光者21 小时前
别再满网找零散工具了,腾讯 QQ 浏览器这个“帮小忙”工具箱真能省时间
前端·后端
心静自然凉80021 小时前
Linux网络核心知识+bonding主备模式配置
后端
带派擂总21 小时前
Python全栈开发精华版最全合集(包含各种面试题) Day24_异常和错误
python