DRF_YASG生成的文档中的自由格式文本

时间:2019-04-03 20:45:39

标签: python django django-rest-framework drf-yasg

是否可以将自由格式的文本添加到通过drf_yasg生成的文档中?我在他们的文档中看不到明显的解释。

我只想添加一些介绍文字。

1 个答案:

答案 0 :(得分:1)

结果证明drf_yasg在说明中支持markdown !!喜欢:

SchemaView = get_schema_view(
    openapi.Info(
        title="My API",
        default_version="v0",
        terms_of_service="",
        contact=openapi.Contact(email="support@example.com"),
        description="""
### Header

Some description text

- bullet 1
- bullet 2
- bullet 3

#### Header
""",
    ),
    public=True,
    patterns=patterns,
    permission_classes=(permissions.AllowAny,),

尽管可能是这样,但我在任何地方都没有看到此文件。但这正是我想要的。