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

相关推荐
程序员爱钓鱼13 分钟前
GoHTML解析利器:github.com/PuerkitoBio/goquery实战指南
后端·google·go
golang学习记24 分钟前
从“大泥球“到模块化单体:Spring Modulith + IntelliJ IDEA 拯救你的代码
后端·intellij idea
颜酱30 分钟前
一步步实现字符串计算器:从「转整数」到「带括号与优化」
javascript·后端·算法
databook34 分钟前
探索视觉的边界:用 Manim 重现有趣的知觉错觉
python·动效
离开地球表面_9935 分钟前
金三银四程序员跳槽指南:从简历到面试再到 Offer 的全流程准备
前端·后端·面试
UrbanJazzerati35 分钟前
Scrapling入门指南:零基础也能学会的网页抓取神器
后端·面试
张洪权36 分钟前
mysql + nest.js 加锁 搞并发问题
后端
郡杰38 分钟前
MyBatisPlus
后端
beata39 分钟前
Java基础-18:Java开发中的常用设计模式:深入解析与实战应用
java·后端
Qlly44 分钟前
DDD 架构为什么适合 MCP Server 开发?
人工智能·后端·架构