如何在不使用装饰器的情况下自定义 Django Rest Framework 文档？

Question

我目前正在开发一个 Django 项目，并利用 Django Rest Framework (DRF) 来构建 API。我已经集成了 drf-pectaulous 来自动生成 API 文档，但我发现使用装饰器来自定义文档会让我的代码库变得混乱。

我有兴趣探索替代方法来自定义我的 DRF 文档，而无需严重依赖装饰器。有人可以提供如何实现这一目标的指导吗？我专门寻找允许我自定义文档同时保持代码整洁和可维护的方法或技术。

任何建议、示例或最佳实践将不胜感激。谢谢！

Answer 1

您可以在此处使用“drf_yasg”模块。您只需要为序列化器和视图传递一个文档字符串，如下所示：

class MyModelSerializer(serializer.ModelSerializer):
    """
       doc string goes here
    """
    model = MyModel
    fields = []

views.py

class MyAPIViewClass(generics.ListAPIView):
    """
       doc string goes here
    """
    permission_classes = []
    serializer_class = MyModelSerializer

因此“drf_yasg”将为您创建文档。