DRF 自动生成接口文档

Python微信订餐小程序课程视频

https://edu.csdn.net/course/detail/36074

Python实战量化交易理财系统

https://edu.csdn.net/course/detail/35475
目录* DRF 自动生成接口文档
+ 接口文档如何去写？
+ 自动生成接口文档
- 设置接口文档路径
- 文档描述说明的定义位置
- 配置文件
- 访问接口文档网页
* 两点说明：

• 如何写好接口文档
  • HTTP携带信息的方式
  • 分离通用信息
  • 路径中的参数表达式
  • 数据模型定义
  • 请求示例
  • 异常处理
  • 如何组织？
    • 一个创建用户的例子：创建用户
    • 这样组织的原因
  • 文档提供的形式

DRF 自动生成接口文档

我们知道前后端分离，前端一般按后端写好的接口去开发，那么就需要我们明细后端接口数据等，需要写接口文档，前端按照接口文档去开发

接口文档如何去写？

1. 使用word或者md文档编写，自己纯手写
2. 第三方平台录入数据，固定的位置填固定的东西

1. EOLINKER（推荐）可以协作，界面简洁
地址：https://www.eolinker.com/#/?status=link-jump
2.RAP（前阿里妈妈团队）支持版本管理，开源，有文档
地址：http://rap2.taobao.org/
3.EasyAPI  （相对来说