django rest_framework 部署doc文档

1.背景

   在实际开发过程中,前后端分离的项目,是需要将一份完整的接口文档交付给前端开发人员,这样有利于开发速度和开发质量,以及有可能减少协同时间。

2.内容

  本项目是以Python+django+rest_framework作为技术框架,在这套框架中,是有自己支持的api文档,现将实现方式整理如下

   2.1默认基础框架已经安装成功

  2.2在主项目中的url中配置如下代码,基于经验在应用路由也可以实现

#在urls.pyh中新增如下代码
  from rest_framework.documentation import  include_docs_urls
  path('docs/', include_docs_urls(title='平台接口文档',
                                    description='接口文档平台'))

 2.3等待自启成功后即可完成api文档接口的渲染。前置条件函数和业务逻辑需要自己实现

3.结尾

遗留项:

1.想要集成 swagger接口开源框架

相关推荐

  1. DjangoRestFramework概括

    2024-01-17 07:04:06       41 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-01-17 07:04:06       19 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-01-17 07:04:06       19 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-01-17 07:04:06       19 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-01-17 07:04:06       20 阅读

热门阅读

  1. 编程探秘:Python深渊之旅-----云端部署(六)

    2024-01-17 07:04:06       33 阅读
  2. BigDecimal使用案例

    2024-01-17 07:04:06       33 阅读
  3. 蓝桥杯简介

    2024-01-17 07:04:06       36 阅读
  4. 后端开发笔记20240106

    2024-01-17 07:04:06       32 阅读
  5. Oracle/DM序列基本使用

    2024-01-17 07:04:06       38 阅读
  6. ubuntu在使用su - root时提示认证失败

    2024-01-17 07:04:06       37 阅读
  7. 后端怎样防止重复提交订单?

    2024-01-17 07:04:06       36 阅读
  8. HC小区管理系统商用测试用例

    2024-01-17 07:04:06       32 阅读