如何通过drf-yasg为ReDoc添加x-server和x-taggroup

Question

我正在使用drf-yasg编写文档，我正在使用redoc，它工作得很好。但我想添加x-server和x-taggroups。我想为视图设置自定义标签，并将它们添加到自己的标签组中，但我在文档中找不到任何关于这方面的内容，我应该如何着手呢？

Answer 1

您可以通过对OpenAPISchemaGenerator进行子类化，在您的模式中包含任意额外的数据(例如x-server和x-tagGroups供应商扩展)。

class MyOpenAPISchemaGenerator(OpenAPISchemaGenerator):
    
    def get_schema(self, request=None, public=False):
        # Get the Swagger object generated by the superclass
        swagger = super().get_schema(request, public)

        # Add any extra fields you want
        swagger['x-tagGroups']=[{
            'name': 'My Group 1',
            'tags': ['myTag1', 'myTag2']
        },{
            'name': 'My Group 2',
            'tags': ['myTag1', 'myTag2', 'myTag3']
        }]
        return swagger

然后，确保在获取SchemaView类时提供自定义生成器类：

schema_view = get_schema_view(
    openapi.Info(
       title="Your API",
       default_version='v1',
       description="Your description",
    ),
    public=True,
    generator_class=MyOpenAPISchemaGenerator, # <--- Don't forget this
    permission_classes=[permissions.AllowAny],
)