drf-yasg 模块细节性说明（自定义请求体，自定义响应体，自定义响应Content-Type, 自定义文档接口标题）

原创

已于 2022-03-10 08:54:08 修改 · 4.3k 阅读

13 ·

CC 4.0 BY-SA版权

文章标签：

#canvas #小程序 #python

于 2021-11-17 09:25:17 首次发布

本文介绍如何使用DRF-YASG为Django REST框架项目生成API文档，包括模块安装、配置步骤及如何定制接口描述、参数和响应。

1.模块安装

pip install drf-yasg

2.模块配置

settings.py中写入以下配置：

SWAGGER_SETTINGS = {
   
   
    'PERSIST_AUTH': True,
    'REFETCH_SCHEMA_WITH_AUTH': True,
    'REFETCH_SCHEMA_ON_LOGOUT': True,

    'SECURITY_DEFINITIONS': {
   
   
        'JWT': {
   
   
            'type': 'apiKey',
            'name': 'Authorization',
            'in': 'header'
        },
    }
}

主路由 urls.py 中写入一下配置：

from django.conf.urls import url
from rest_framework import permissions

from drf_yasg import openapi
from drf_yasg.views import get_schema_view

from utils.login import LoginObtainJSONWebToken

SchemaView = get_schema_view(
    openapi.Info(
        title="XXXXX服务平台",
        default_version='v1.0',
        description="""
            XXXXX平台 API 遵循 REST 标准进行设计。
            我们的 API 是 可预期的 以及 面向资源 的，接受 `form-encoded` 请求正文，返回 `JSON-encoded` 响应， 使用标准的 HTTP 响应代码 ，认证（JWT）和参数。
            所有请求和响应的编码均为 UTF-8。
        """,
        contact=openapi.Contact(email="1182900548@qq.com"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    # schema view本身的权限类
    permission_classes=(permissions