Описание тега drf-spectacular

Вопросы с тегом
1 ответ

drf-impression: Добавить описание в HTTP_204

@extend_schema( request=MyRequestSerializer, responses={200: MyResponseSerializer(many=True), 204: None, }, examples=[ OpenApiExample( '204', status_codes=['204'], summary="My documentation summary", description="My documentation description", resp…
15 фев '21 в 21:21
2 ответа

Есть ли способ перезаписать описание по умолчанию сгенерированной схемы api drf?

При использовании drf-yasg или drf-spectular，есть ли способ перезаписать описание по умолчанию, показанное в образце изображения, или drf-yasg или drf-Spectrum обеспечивает поддержку других языков для описания по умолчанию? Я попробовал i18n с подде…
07 апр '21 в 06:07
1 ответ

Передайте URL-адрес Swagger-UI в настройках drf-впечатляющих

У меня есть проект, написанный на Django 2.x.Я хочу добавить к нему автоматическую документацию с помощью drf-spectular . я использую drf-spectacular=0.15.1 в данный момент. Я запускаю свой проект в Docker, и контекст сборки для моего контейнера api…
08 май '21 в 19:03
1 ответ

Использование FileField с пользовательским интерфейсом Swagger и drf-впечатляющим

У меня есть проект Django REST Framework, в котором используется ModelViewSet для создания API-интерфейсов для модели, содержащей. Я поделился полным примером проекта Django, демонстрирующим эту проблему здесь . Но резюмируем ключевые компоненты: mo…
13 май '21 в 18:11
1 ответ

drf-effectular: как показать первичный ключ в разделе примеров Swagger

Я пытаюсь показать первичный ключ в разделе примеров Swagger, я использую drf-Spectrum, и мой код выглядит так: Serializers.py class SerializerExample(serializers.ModelSerializer): class Meta: model = Book fields = ('id','name') Views.py class Books…
14 май '21 в 12:09
2 ответа

DRF - впечатляющая проблема с пользовательским интерфейсом при расширении новой аутентификации TokenAuthentication для DRF

при расширении нового класса аутентификации токена из rest_framework_simplejwt.authentication.JWTAuthentication кнопка авторизации drf-Spectular swagger-ui исчезает, и нет возможности добавить носителя токена, я думаю, когда вы подклассифицируете, э…
17 май '21 в 12:44
1 ответ

drf-effectular: укажите пустую полезную нагрузку с помощью @extend_schema

Считайте, что у меня есть простая точка зрения: # serializers.py class EmptyPayloadResponseSerializer(serializers.Serializer): detail = serializers.CharField() # views.py from rest_framework.views import APIView from rest_framework.response import R…
22 май '21 в 15:09
2 ответа

Различные описания методов в пользовательском @action для маршрутизации

Я сделал настраиваемый маршрутизируемый метод с декоратором @action для DRF ViewSet. В этом маршруте реализовано несколько методов (GET, POST, DELETE). Можно ли иметь разные описания для каждого метода или даже создавать разные определения @extend_s…
09 июн '21 в 08:49
1 ответ

Расширение_schema drf-Spectular не работает

Я недавно перешел из drf-yasg к drf-spectacular в моем проекте, но @extend_schema декоратор, похоже, не добавляет никакой информации в мою сгенерированную схему: views.py class SearchView(GenericViewSet): serializer_class = serializers.CriterionSeri…
15 июн '21 в 12:45
0 ответов

Понижение версии open api в drf впечатляюще во фреймворке django rest [закрыто]

У меня есть проект в Django Rest Framework (djangorestframework == 3.12. *), И теперь я использую drf-spectacular == 0.17.0 и у меня есть open api version 3.0.3. Мне нужен открытый API версии 3.0.1. Пытался сделать это, понизив версию drf-Spectular …
10 авг '21 в 12:54
0 ответов

drf-впечатляющие объекты, связанные с обратной связью

У меня проблема с обратными связанными объектами в схеме. Сериализаторы: class MessageSerializer(serializers.ModelSerializer): files = FileUploadSerializer(many=True, required=False) class Meta: model = Message fields = ['id', 'sender', 'recipient',…
14 авг '21 в 12:34
1 ответ

Как отправлять пользовательские заголовки JSON с запросами в drf_spectacular (django)?

Могу ли я создать собственное описание заголовков JSON в drf_spectacular без использования класса сериализаторов в декораторе @extend_schema?
16 авг '21 в 16:13
4 ответа

Django drf-Spectular - Можете ли вы исключить определенные пути?

У нас есть несколько API с разными версиями в urls.py, например api / v1 api / v2 api / v3 . Мы хотим реализовать чванство с помощью drf-spectular, но мы хотим только предоставить доступ к конечным точкам api / v3. Есть ли способ сделать это? Я не м…
26 авг '21 в 20:34
1 ответ

Какие есть варианты фильтрации значений Enums из документации Swagger?

Я использую Django с drf-spectacularпакет для создания документации Swagger. Мне было интересно, есть ли лучший подход для фильтрации некоторых значений из раздела Enum внутри схемы. Прямо сейчас я сделал это с помощью кастомного хука preprocess_sch…
22 сен '21 в 16:08
1 ответ

Использование extend_schema_field для настраиваемого поля

Я создал настраиваемое поле с именем, которое создает миниатюры с загруженными изображениями, и использовал его в своем Userмодель Модель пользователя: class User(AbstractBaseUser): profile_image = PictureField(make_thumbnail=True) Мой PictureField,…
25 сен '21 в 04:20
2 ответа

Определите схему компонентов с помощью drf-Spectrum для django API

Я использую drf-spectular для создания схемы OpenAPI для django. Поскольку я не использую сериализаторы, я определяю все в extend_schemaдекоратор. Теперь у меня вопрос, можно ли вручную определить схему компонентов. Вот пример того, как выглядит мое…
07 окт '21 в 16:29
2 ответа

drf впечатляюще не показывает параметры запроса в пользовательском интерфейсе swagger

У меня есть общий ListAPIView со следующей функцией запроса списка. Здесь категория - это параметр запроса. Я пытаюсь добиться того, чтобы пользовательский интерфейс swagger также отображал параметр запроса в документе пользовательского интерфейса s…
06 сен '21 в 07:40
1 ответ

drf-Spectrum не работает при использовании управления версиями (в спецификации не определены операции!)

Несколько недель назад я установил. Все работало правильно, пока я не включил управление версиями в DRF (Django Rest Framework). Я реализовал, и он работал правильно. Но потом я понял, что Swagger не показывает конечные точки в / docs /, и было пока…
05 окт '21 в 11:41
0 ответов

Самостоятельное документирование представлений модели Django Drf

Надеялся создать настраиваемый ModelViewSet для наследования, который создает обобщенную информацию о различных маршрутах CRUD. Прямо сейчас мы должны перезаписать методы, которые не нуждаются в изменении. Некоторые представления требуют перезаписи …
30 сен '21 в 22:31
1 ответ

Как отключить расширение схемы для одной схемы в чванстве?

я использую Django с участием DRF-Spectacular а также swagger-ui. Меня интересует, как отключить расширение схемы (только одна схема, связанная с токенами), чтобы отображалась только конечная точка.
15 окт '21 в 11:25