DRF_Yasg.openapiInfo()详解

DRF_Yasg是一个Django REST框架的插件，它可以自动生成REST API的文档。该插件提供了一个openapi_info函数，用于设置生成文档的一些信息。

下面是对DRF_Yasg.openapiInfo()的详细解释，并附上使用例子：

openapi_info方法可以接受一个字典作为参数，这个字典包含了生成文档的一些信息。包括标题、版本号、描述、联系人信息等。

例子：

from drf_yasg.openapi import Info
from drf_yasg import openapi

def openapi_info():
    info = {
        'title': 'My API',  # 标题
        'version': '1.0',  # 版本号
        'description': 'My API description',  # 描述
        'terms_of_service': 'https://www.example.com/terms/',  # 服务条款
        'contact': {  # 联系人信息
            'name': 'API Support',
            'url': 'https://www.example.com/support/',
            'email': 'support@example.com',
        },
        'license': {  # 许可证信息
            'name': 'Apache 2.0',
            'url': 'http://www.apache.org/licenses/LICENSE-2.0.html',
        },
    }
    return openapi.Info(**info)

swagger_info = openapi_info()

在上面的例子中，我们使用openapi_info函数定义了生成文档的信息。其中包括了标题、版本号、描述、服务条款、联系人信息和许可证信息。

我们可以使用openapi.Info(**info)将字典转换成一个openapi.Info对象，然后将其传递给DRF_Yasg的openapi_info方法。

示例中返回的swagger_info对象可以在生成文档的时候使用。例如，在Django的settings.py文件中，我们可以定义如下的配置：

SWAGGER_SETTINGS = {
    'DEFAULT_INFO': 'my_project.openapi_info',
}

在上面的配置中，我们将my_project.openapi_info作为DEFAULT_INFO参数的值，这样在生成文档的时候，DRF_Yasg就会使用我们定义的信息。

总结：

DRF_Yasg的openapi_info方法用于设置生成REST API文档的一些信息，包括标题、版本号、描述、联系人信息等。使用方法是定义一个字典，然后将其通过openapi.Info(**info)转换成openapi.Info对象，最后将其传递给openapi_info方法即可。生成的swagger_info对象可以在生成文档的时候使用。