DRF使用swagger进行自动生成API接口-1

Django Rest Framework自动生成API接口–swagger

1. 推荐 drf_yasg 第三方包
2. 推荐原因
   • 紧密结合了DRF框架, 灵活
   • 使用swagger生成API (swagger的优点不再赘述)
   • 同时使用 redoc 生成详细的接口文档

• 不想看本文的直接跳转官网

1. 安装

   pip install -U drf-yasg
   

2. 配置+使用

   # settings.py
   INSTALLED_APPS = [
      ...
      'drf_yasg',
      ...
   ]
   # urls.py
   from rest_framework import permissions
   from drf_yasg.views import get_schema_view
   from drf_yasg import openapi
   
   ...
   
   schema_view = get_schema_view(
      openapi.Info(
         title="Demo API",
         default_version='v1',
         description="Demo description",
      ),
      public=True,
      permission_classes=(permissions.AllowAny,),
   )
   
   urlpatterns = [
      path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
      path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
      ...
   ]
   

• 下一步: 配置自己需求的认证