自动生成接口文档

REST framework可以自动帮助我们生成接口文档。

接口文档以网页的方式呈现。

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

 

1安装依赖

pip install coreapi

 

2 设置接口文档访问路径

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

from rest_framework.documentation import include_docs_urls

urlpatterns = [
...
path('docs/', include_docs_urls(title='站点页面标题'))
]

 

其它参考: 自动生成接口文档 - 迷恋~以成伤 - 博客园 (cnblogs.com)

posted @ 2023-07-05 08:43  tslam  阅读(15)  评论(0编辑  收藏  举报