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