DRF自动生成接口文档

自动生成接口文档

自动生成接口文档对于开发、运维以及和前端联调接口都是很有用的，所以DRF也有自动生成接口文档功能。

接口文档以网页的方式呈现。类似Java项目的swagger

自动接口文档能生成的是继承自APIView及其子类的视图。函数视图不会自动生成接口文档

安装依赖

REST framewrok生成接口文档需要coreapi库的支持。

pip install coreapi

设置接口文档访问路径

在总路由中添加接口文档路径。

文档路由对应的视图配置为rest_framework.documentation.include_docs_urls，

参数title为接口文档网站的标题。

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    url(r'^docs/', include_docs_urls(title='My API title'))
]

然后启动项目，通过浏览器访问文档配置的路由即可看到接口文档