DRF_Yasg.openapiInfo()实现自定义操作指南

DRF_Yasg是一个Django Rest Framework的插件，它可以根据DRF的代码生成Swagger/OpenAPI文档。DRF_Yasg.openapiInfo()是一个API接口，用于返回一个包含自定义操作指南的OpenAPI文档配置对象。在这篇文章中，我们将详细介绍如何使用DRF_Yasg.openapiInfo()来实现自定义操作指南，并提供相应的使用例子。

首先，我们需要安装DRF_Yasg插件。可以通过运行以下命令来安装它：

pip install drf-yasg

安装完成后，我们可以在Django的settings.py文件中进行配置。首先要将DRF_Yasg添加到INSTALLED_APPS中：

INSTALLED_APPS = [
    ...
    'drf_yasg',
    ...
]

然后，在settings.py文件的底部添加以下配置：

SWAGGER_SETTINGS = {
    'DEFAULT_INFO': 'myapp.urls.openapi_info',  # 自定义操作指南
}

在上述配置中，我们指定了一个名为'openapi_info'的自定义函数来生成操作指南。下面我们就来创建这个函数。

打开myapp/urls.py文件，添加一个openapi_info函数，并编写下面的代码：

from django.urls import path
from drf_yasg.openapi import Info

def openapi_info():
    info = Info(
        title="My API",
        default_version='v1',
        description="This is a sample API",
    )

    # 定义要在操作指南中显示的自定义标签
    info.version_labels = {
        'v1-beta': 'Beta Version',
        'v2': 'Latest Version',
    }

    return info

urlpatterns = [
    ...
]

在上述代码中，我们创建了一个Info对象，用于存储操作指南的信息。我们可以自定义title、default_version和description。然后，我们定义了一个version_labels属性，用于指定要在操作指南中显示的自定义标签。在这个例子中，我们添加了两个自定义标签：'v1-beta'和'v2'。

现在，我们可以开始添加路径和视图函数到urlpatterns中了。在本例中，我们假设我们有如下的视图函数：

from django.http import JsonResponse

def my_view(request):
    data = {
        'message': 'Hello, world!',
    }
    return JsonResponse(data)

我们可以在urlpatterns中添加一个路径和这个视图函数：

from myapp.views import my_view

urlpatterns = [
    path('hello/', my_view, name='hello'),
    ...
]

完成上述配置后，我们可以运行Django开发服务器，并通过访问Swagger UI页面查看生成的操作指南。默认情况下，Swagger UI的URL是/api/docs/，可以根据需要进行更改。

在Swagger UI页面中，我们可以看到自定义的标题、默认版本和描述显示在顶部。然后，在右侧的版本下拉菜单中，我们可以切换标签版本。

在示例代码中，我们添加了两个自定义标签：'v1-beta'和'v2'。当我们选择'v1-beta'时，可以看到第一个版本的相关信息。当我们选择'v2'时，可以看到最新版的相关信息。

通过使用DRF_Yasg的DRF_Yasg.openapiInfo()函数，我们可以方便地实现自定义操作指南。在自定义函数中，我们可以设置多个属性来修改操作指南的显示内容，以满足项目需求。

总的来说，使用DRF_Yasg.openapiInfo()函数可以方便地生成自定义操作指南，并且可以根据项目的需求进行定制。这个函数提供了大量的属性设置，可以帮助我们创建具有个性化和专业外观的操作指南。