自动文档框架调研

原文见 : https://chen-yijie.blogspot.com/2018/10/django-restframework-document.html

由于项目打算基于Django故首先调研了几个与Django相关的

1.django restframework自带文档模块 基于coreapi

- 支持代码内文档自动生成，格式较为简单

- 查看文档时可以进行测试并生成客户端代码(py,js)

2. 使用第三方的 Django REST Swagger基于swagger UI

- 使用方法类似与django restframework自带文档模块，都是支持自动扫描与手动描述

- UI有一点差异

3. Swagger Editor：通用的文档编辑与测试框架

- 文档驱动的服务端与客户端开发，支持自动生成服务端与客户端代码，只需要补充业务逻辑代码，支持数十种语言与框架(似乎没有django)

- 使用yaml或者json作为文档描述

案例可见http://editor.swagger.io/#

4.drfdocs : 适配于django restframework, 看上去类似于官方文档模块

[参考链接]

https://django-rest-swagger.readthedocs.io/en/latest/

https://www.jianshu.com/p/dc77f652e7d7