DRF YASG自定义

基础概念： DRF YASG（Django REST Framework Yet Another Swagger Generator）是一个用于Django REST Framework（DRF）项目的Swagger/OpenAPI文档生成器。它可以帮助开发者自动生成API文档，使得API的使用者能够更方便地理解和调用API。

优势：

1. 自动生成API文档，节省了手动编写文档的时间。
2. 提供交互式的API文档界面，便于测试和调试。
3. 支持Swagger UI和ReDoc两种风格的文档展示。
4. 可以自定义文档的各个部分，以满足特定的需求。

类型：

• 视图级自定义：可以针对特定的视图或视图集进行自定义设置。
• 全局配置：通过修改项目的设置文件，可以对整个项目的Swagger文档生成进行统一配置。

应用场景：

• 当你需要为你的DRF项目提供详细的API文档时。
• 当你希望API的使用者能够通过一个友好的界面来了解和使用你的API时。
• 当你需要对API文档进行一定程度的个性化定制时。

常见问题及解决方法：

问题1：如何自定义API文档的标题和描述？ 解决方法： 在项目的settings.py文件中，可以通过修改YASG_SETTINGS来设置全局配置，例如：

YASG_SETTINGS = {
    'SWAGGER_SETTINGS': {
        'TITLE': '我的API文档',
        'DESCRIPTION': '这是一个用于...的API文档。',
        # 其他设置...
    }
}

问题2：如何在视图中添加自定义的描述信息？ 解决方法： 可以在视图类中使用swagger_auto_schema装饰器来添加自定义描述：

from drf_yasg.utils import swagger_auto_schema

class MyView(APIView):
    @swagger_auto_schema(
        operation_description="这是一个自定义的操作描述。",
        responses={200: '成功响应的描述'}
    )
    def get(self, request, format=None):
        # 视图逻辑...

问题3：如何隐藏某个视图或端点不被Swagger文档显示？ 解决方法： 可以使用@swagger_auto_schema装饰器的exclude_from_schema参数来隐藏特定的视图或端点：

class HiddenView(APIView):
    @swagger_auto_schema(exclude_from_schema=True)
    def get(self, request, format=None):
        # 视图逻辑...

确保在实施这些自定义设置时，遵循DRF YASG的官方文档指南，以确保配置的正确性和有效性。