Текст произвольной формы внутри документов, сгенерированных DRF_YASG

#python #django #django-rest-framework #drf-yasg

#python #django #django-rest-framework #drf-yasg

Вопрос:

Есть ли способ добавить текст произвольной формы в документы, сгенерированные через drf_yasg? Я не вижу очевидного объяснения в их документах.

Я просто хочу добавить несколько разделов текста введения.

Ответ №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,),

  

Я нигде не видел этого документированного, хотя это могло бы быть. Но это именно то, что я искал.