drf——自动生成接口文档
自动生成接口文档
1 借助于第三方:coreapi,swagger #先安装好这两个模块 2 在路由中(此处省略了自动生成的students路由) from rest_framework.documentation import include_docs_urls
urlpatterns = [
path('student_apiview/', views.StudentApiView.as_view()),
path('docs/', include_docs_urls(title='图书管理系统api')),
path('books/', views.BookListCreateView.as_view()),
]
3 在配置文件中 REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema', } 4 写视图类(需要加注释) class BookListCreateView(ListCreateAPIView): """ get: 返回所有图书信息. 写什么就显示出什么,但get一定要写 post: 新建图书.
写什么就显示出什么,但post一定要写 """ queryset = Student.objects.all() serializer_class = StudentSerializer
5 只需要在浏览器输入,就可以看到自动生成的接口文档() http://127.0.0.1:8000/docs/
显示:
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步