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 分钟前
入职软件开发与实施工程师了后........
后端
小峰编程12 分钟前
Python函数——万字详解
linux·运维·服务器·开发语言·前端·网络·python
薯条不要番茄酱31 分钟前
【SpringBoot】从零开始全面解析SpringMVC (三)
java·spring boot·后端
水木姚姚37 分钟前
用 python 编写的一个图片自动分类小程序(三)
python·opencv·图片分类·图片识别
赱向远方1 小时前
【软件推荐——pdf2docx】
python·pdf·开源软件·docx·软件推荐·doc·pdf2docx
编程乐学(Arfan开发工程师)1 小时前
10、底层注解-@Conditional条件装配
java·spring boot·后端·架构
半青年2 小时前
Qt读取Excel文件的技术实现与最佳实践
c语言·c++·python·qt·c#·excel
无闻墨客2 小时前
数据分析与应用---数据可视化基础
python·信息可视化·数据挖掘·数据分析·matplotlib
xiaohanbao092 小时前
day30 python 模块、包与库的高效使用指南
人工智能·python·学习·算法
Q_Q19632884752 小时前
python动漫论坛管理系统
开发语言·spring boot·python·django·flask·node.js·php