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

相关推荐
名字还没想好☜5 分钟前
Go 的 sync.Cond 实战:用条件变量做等待/通知,比忙轮询省 CPU
开发语言·数据库·后端·golang·go
李可以量化16 分钟前
Tornado 从入门到精通(二)下:协程调用方式与经典使用模式
python
雪碧透心凉_24 分钟前
Python OpenCV图像处理入门
图像处理·python·opencv
zzzll111128 分钟前
Spring Boot 入门指南:从零开始构建微服务
spring boot·后端·微服务
李可以量化38 分钟前
Tornado 从入门到精通(二)上:协程核心机制详解
python
晴天1641 分钟前
AgentLoop分享(上): 让 AI 真正“自主干活“-Day15
人工智能·python
运维行者_1 小时前
企业带宽监控工具实战:网络流量分析与异常排查的5个关键能力
运维·服务器·开发语言·网络·分布式·后端·php
Patrick在香港1 小时前
Python爬虫框架实战:优雅抓取香港政府公开API数据的通用方案
java·开发语言·爬虫·python·ai编程·数据可视化·可用性测试
长栎1 小时前
你用了五年的消息队列,不知道它背后站着中介者模式
后端
Gopher_HBo1 小时前
路由注册:RouterGroup(routergroup.go)
后端