Как скрыть некоторые функции из view в swagger?

@denjamin11 · Регистрация: 15.04.2019

Author24 — интернет-сервис помощи студентам

Доброго времени суток! Требуется написать документацию API. Начал копать инфу про swagger. Использую библиотеку drf_yasg, а именно декоратор @swagger_auto_schema. Хочу скрыть некоторые функции, чтобы не отображались в swagger ui. Прочитал, что у декоратора есть параметр exclude.

Пытаюсь использовать декоратор следующим образом:

Код

@swagger_auto_schema(methods=['get', 'post'], exclude=True)
@api_view(http_method_names=["GET", "POST"])
@permission_classes([IsAdminUser])  # ([IsAuthenticated])  ([AllowAny])
def registration_f(request: WSGIRequest) -> Response:...

Выдает ошибку, либо не скрывает в swagger ui.

Как скрыть некоторые функции из view в swagger?

Хочу понять как скрывать функции.

В settings.py ничего не добавлял. В основной urls.py добавил следующее:

Python

from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
 
schema_view = get_schema_view(
   openapi.Info(
      title="Snippets API",
      default_version='v1',
      description="Test description",
      # terms_of_service="https://www.google.com/policies/terms/",
      # contact=openapi.Contact(email="contact@snippets.local"),
      license=openapi.License(name="BSD License"),
   ),
   # patterns=[path('api/', include('django_app.urls')), ],
   # excluded_paths=['/admin/', '/healthcheck/'],
   public=True,
   permission_classes=[permissions.AllowAny],
 
urlpatterns = [
    ...
    re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
    re_path(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
    re_path(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
    ...
]

@kazak · 24.03.2023, 18:04

https://buildmedia.readthedocs... f-yasg.pdf

You can prevent a view from being included in the Swagger view by setting its class-level swagger_schema attribute to None, or you can prevent an operation from being included by setting its auto_schema override to none
in @swagger_auto_schema:

Python

class UserList(APIView):
    swagger_schema = None
    # all methods of the UserList class will be excluded
...
# only the GET method will be shown in Swagger
@swagger_auto_schema(method='put', auto_schema=None)
@swagger_auto_schema(methods=['get'], ...)
@api_view(['GET', 'PUT'])
def user_detail(request, pk):
    pass

Добавлено через 2 минуты
И еще вариант https://github.com/marcgibbons... t-36422378

@denjamin11 · 24.03.2023, 19:56 **[ТС]**

Попробовал сделать через auto_schema. Работает.
Вчера когда решение тоже нашел этот метод, но PyCharm ругался. Я подумал, что что-то не то. В следующий раз не смотря на PyCharm буду тестить.

@denjamin11 0 / 0 / 0 Регистрация: 15.04.2019 Сообщений: 138
	24.03.2023, 19:56 [ТС]	3
	Попробовал сделать через auto_schema. Работает. Вчера когда решение тоже нашел этот метод, но PyCharm ругался. Я подумал, что что-то не то. В следующий раз не смотря на PyCharm буду тестить. 0