Форум программистов, компьютерный форум, киберфорум
Python: Django
Войти
Регистрация
Восстановить пароль
Блоги Сообщество Поиск Заказать работу  
 
Рейтинг 5.00/5: Рейтинг темы: голосов - 5, средняя оценка - 5.00
0 / 0 / 0
Регистрация: 15.04.2019
Сообщений: 138

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

24.03.2023, 17:38. Показов 1244. Ответов 2

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

Пытаюсь использовать декоратор следующим образом:
Code
1
2
3
4
@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.



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

В settings.py ничего не добавлял. В основной urls.py добавил следующее:
Python
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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'),
    ...
]
0
Programming
Эксперт
39485 / 9562 / 3019
Регистрация: 12.04.2006
Сообщений: 41,671
Блог
24.03.2023, 17:38
Ответы с готовыми решениями:

Как скрыть некоторые компоненты!
Напишите программу, которая отображала бы на первом этапе информацию о набираемом пароле, а на втором - вводимую информацию в виде общих...

Как скрыть от PropertyGrid некоторые Event
как скрыть от PropertyGrid некоторые Event. Вот так к примеру я скрываю свойства: public class PGConverter : TypeConverter ...

Как скрыть некоторые материалы в категории?
Есть вот такая страничка: ССЫЛКА Необходимо сделать так, чтобы пункты &quot;Материал тест 1&quot; и &quot;Материал тест 2&quot; не...

2
 Аватар для kazak
3601 / 2742 / 355
Регистрация: 11.03.2009
Сообщений: 6,300
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
1
2
3
4
5
6
7
8
9
10
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
0
0 / 0 / 0
Регистрация: 15.04.2019
Сообщений: 138
24.03.2023, 19:56  [ТС]
Попробовал сделать через auto_schema. Работает.
Вчера когда решение тоже нашел этот метод, но PyCharm ругался. Я подумал, что что-то не то. В следующий раз не смотря на PyCharm буду тестить.
0
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
inter-admin
Эксперт
29715 / 6470 / 2152
Регистрация: 06.03.2009
Сообщений: 28,500
Блог
24.03.2023, 19:56
Помогаю со студенческими работами здесь

Как скрыть некоторые категории из формы добавления новостей?
Приветствую, установлен хак (несколько форм добавление новостей), в связи с этим вопрос, как скрыть некоторые категории из определённой...

Как в производном классе скрыть некоторые свойства и методы базового?
Есть класс, производный от некого базового класса. Как в моем классе скрыть некоторые свойства и методы базового?

Несколько подчиненных отчетов - как можно некоторые скрыть/показать
Привет! Тут придумал себе головную боль: На главном отчете расположено несколько подчиненных запросов (предположим с именами child_1,...

BrowsableAttribute для обытий класса, как скрыть от PropertyGrid некоторые Event
здравствуйте, собственно интересует вопрос как скрыть от PropertyGrid некоторые Event, свойства я скрываю так, создав наследника от...

Некоторые недостатки View State
Объясните, пожалуйста, недостатки ViewState Затруднение хранения данных, которые не сможет менять пользователь. Невозможность...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
3
Ответ Создать тему
Новые блоги и статьи
PhpStorm 2025.3: WSL Terminal всегда стартует в ~
and_y87 14.12.2025
PhpStorm 2025. 3: WSL Terminal всегда стартует в ~ (home), игнорируя директорию проекта Симптом: После обновления до PhpStorm 2025. 3 встроенный терминал WSL открывается в домашней директории. . .
Как объединить две одинаковые БД Access с разными данными
VikBal 11.12.2025
Помогите пожалуйста !! Как объединить 2 одинаковые БД Access с разными данными.
Новый ноутбук
volvo 07.12.2025
Всем привет. По скидке в "черную пятницу" взял себе новый ноутбук Lenovo ThinkBook 16 G7 на Амазоне: Ryzen 5 7533HS 64 Gb DDR5 1Tb NVMe 16" Full HD Display Win11 Pro
Музыка, написанная Искусственным Интеллектом
volvo 04.12.2025
Всем привет. Некоторое время назад меня заинтересовало, что уже умеет ИИ в плане написания музыки для песен, и, собственно, исполнения этих самых песен. Стихов у нас много, уже вышли 4 книги, еще 3. . .
От async/await к виртуальным потокам в Python
IndentationError 23.11.2025
Армин Ронахер поставил под сомнение async/ await. Создатель Flask заявляет: цветные функции - провал, виртуальные потоки - решение. Не threading-динозавры, а новое поколение лёгких потоков. Откат?. . .
Поиск "дружественных имён" СОМ портов
Argus19 22.11.2025
Поиск "дружественных имён" СОМ портов На странице: https:/ / norseev. ru/ 2018/ 01/ 04/ comportlist_windows/ нашёл схожую тему. Там приведён код на С++, который показывает только имена СОМ портов, типа,. . .
Сколько Государство потратило денег на меня, обеспечивая инсулином.
Programma_Boinc 20.11.2025
Сколько Государство потратило денег на меня, обеспечивая инсулином. Вот решила сделать интересный приблизительный подсчет, сколько государство потратило на меня денег на покупку инсулинов. . . .
Ломающие изменения в C#.NStar Alpha
Etyuhibosecyu 20.11.2025
Уже можно не только тестировать, но и пользоваться C#. NStar - писать оконные приложения, содержащие надписи, кнопки, текстовые поля и даже изображения, например, моя игра "Три в ряд" написана на этом. . .
Мысли в слух
kumehtar 18.11.2025
Кстати, совсем недавно имел разговор на тему медитаций с людьми. И обнаружил, что они вообще не понимают что такое медитация и зачем она нужна. Самые базовые вещи. Для них это - когда просто люди. . .
Создание Single Page Application на фреймах
krapotkin 16.11.2025
Статья исключительно для начинающих. Подходы оригинальностью не блещут. В век Веб все очень привыкли к дизайну Single-Page-Application . Быстренько разберем подход "на фреймах". Мы делаем одну. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2025, CyberForum.ru