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

相关推荐
卿雪几秒前
MySQL【基础】篇:什么是MySQL、主键和外键、三大范式、DDL、DML、DDL、DCL...
java·服务器·开发语言·数据库·后端·mysql·golang
AI视觉网奇3 分钟前
数字人 语音驱动
人工智能·python
胡乱儿起个名4 分钟前
Embedding查表操作
python·机器学习·embedding
伯远医学4 分钟前
CUT&RUN
java·服务器·网络·人工智能·python·算法·eclipse
一晌小贪欢5 分钟前
Python-11 Python作用域与闭包:LEGB规则深度解析
开发语言·python·python基础·python小白·python作用域·python小庄
战南诚6 分钟前
如何查看正在执行的事务
python·flask·sqlalchemy
丸码6 分钟前
JDK1.8新特性全解析
linux·windows·python
@游子7 分钟前
Python学习笔记-Day4
笔记·python·学习
艾莉丝努力练剑7 分钟前
【Python基础:语法第二课】Python 流程控制详解:条件语句 + 循环语句 + 人生重开模拟器实战
人工智能·爬虫·python·pycharm
Dest1ny-安全8 分钟前
CTF 及网络安全相关平台汇总表
java·运维·服务器·python·安全·web安全