django-rest-framework教程6-如何使用DRF中的API接口文档

()1. 如何生成API接口文档

(1)settings.py文件中增加配置

REST_FRAMEWORK = {
    # 自动生成API接口文档配置
    "DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.AutoSchema",
    ......,
}

(2)项目的根urls.py文件中增加配置

from rest_framework.schemas import get_schema_view

schema_view = get_schema_view(title="DRF API", description="简单描述")

urlpatterns = [
    path('admin/', admin.site.urls),
    path("schema/", schema_view),  # 接口文档
]

(3)浏览器中访问我们的接口文档,http://127.0.0.1:8000/schema/, 此时会显示API文档,但是太丑陋

需使用JsonView格式显示,谷歌浏览器需要安装插件JsonView插件,教程如下:

https://blog.csdn.net/weixin_42182448/article/details/81630083

2. DRF的概要使用方法介绍

上面生成的drf api文档过于简单不好看,现在我们生成一个非常美观的API文档

(1)修改settings.py文件中的配置

REST_FRAMEWORK = {
    # 自动生成API接口文档配置
    "DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.coreapi.AutoSchema",
    ......,
}

(2)修改项目的根urls.py文件中的配置

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    path('admin/', admin.site.urls),
    path("docs/", include_docs_urls(title="DRF API文档", description="django-rest-framework快速入门")),
]

(3)效果如下:

已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 技术黑板 设计师:CSDN官方博客 返回首页