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

Вопросы с тегом
Автоматическая генерация реальных схем Swagger/OpenAPI 2.0 из кода Django Rest Framework
0 ответов

drf-yasg, конечная точка фильтра в зависимости от прав пользователя

У меня есть приложение Django с множеством конечных точек... и теперь я хочу сделать из них документацию. Для этого я использую библиотеку drf-yasg. Но моя проблема в том, что у меня есть разные типы пользователей (суперпользователь, администратор, …
03 янв '19 в 09:45
2 ответа

"Метод http не привязан к просмотру" при документировании представления на основе классов в drf_yasg

Ранее я задокументировал свои функциональные представления следующим образом: @swagger_auto_schema( operation_id='ChangePassword', methods=['POST'], request_body=ChangePasswordSerializer, responses={ '200': 'empty response body', }) def change_passw…
22 янв '18 в 07:54
3 ответа

Исключить документы о подмене для определенных методов HTTP

Я использую drf-yasg для генерации документации для моего REST API Django. У меня есть пара конечных точек, элементов / с методами GET, POST и DELETE; и items /только с методом DELETE. Тем не менее, сгенерированные документы swagger ошибочно включаю…
15 окт '18 в 09:08
1 ответ

Добавить описание чванства в комментариях

Могу ли я настроить описание сваггера с помощью набора комментариев? Я использую drf-yasg. Мой код: class MetricViewSet(viewsets.ReadOnlyModelViewSet): """ retrieve: Получить из справочника данные записи о метрике по *uuid* list: Получить из справоч…
30 авг '18 в 08:49
0 ответов

Как добавить параметры публикации в документ API (drf_yasg)?

x_param = openapi.Parameter('x', in_=openapi.IN_FORM, description='srring', type=openapi.TYPE_STRING) y_param = openapi.Parameter('y', in_=openapi.IN_FORM, description='string', type=openapi.TYPE_STRING) @swagger_auto_schema(method='post', manual_pa…
19 июн '18 в 12:59
0 ответов

drf_yasg не принимает TYPE_ARRAY в качестве допустимого типа

Генератор swfger drf_yasg не принимает TYPE_ARRAY в качестве допустимого типа параметра. реализация заключается в следующем from drf_yasg import openapi param1 = openapi.Parameter('param_name', in_=openapi.IN_QUERY, description='description of param…
27 ноя '18 в 04:41
0 ответов

Трясогузка рядом с Django Rest Framework drf-yasg?

Я реализую блог на основе Wagtail в более крупном (в первую очередь, DRF) приложении. Я пытаюсь использовать drf-yasg для моей документации. После установки трясогузки, документы теперь выкидывают 'Request' object has no attribute 'wagtailapi_router…
04 июн '18 в 05:21
0 ответов

Шаблоны расширений django, которые не имеют секций блоков

Я должен расширить redoc.html из drf-yasg и добавить простое навигационное меню. когда я проверяю redoc.html в файле drf_yasg/templates/drf-yasg/redoc.html, я не вижу {{block}} раздела. как мне продлить это? Я не хочу копировать весь код, а затем из…
02 ноя '18 в 00:44
2 ответа

Как удалить автоматически сгенерированные поля из DRF - Swagger UI

У меня есть модель, где несколько полей создаются автоматически. Как скрыть эти поля из интерфейса Swagger во время запроса POST? Ниже приведен пример: class ModelX(models.Model): a = models.CharField() b = models.CharField() c = models.CharField() …
05 ноя '18 в 08:55
1 ответ

DRF - `write_only=True` отображается в схеме ответа

Я использую drf-yasg для документирования своих API. Тем не менее, я сталкиваюсь с проблемой У меня есть сериализатор, в котором одно из полей установлено в write_only=True, class XYZSerializer(serializers.ModelSerializer): status = serializers.Bool…
11 июл '18 в 12:39
1 ответ

get_queryset для ListCreateAPIView не вызывается

У меня есть ListCreateAPIView, который я пытаюсь переопределить get_queryset, но он никогда не вызывается. Вот мой взгляд: class DeviceView(generics.ListCreateAPIView): def get_queryset(self): # Threw this and some print statements, but no sign of #…
29 ноя '18 в 13:14
1 ответ

URL-адрес сообщения DRF без косой черты

В моем приложении мне нужно отобразить URL REST без косой черты в конце. Я попробовал ниже комбинацию, но она не сработала. добавленной APPEND_SLASH=True в settings.py и в файле urls.py from rest_framework.routers import SimpleRouter router = Simple…
16 июл '18 в 07:45
2 ответа

Аутентификация документов API Swagger (drf-yasg)

Я настроил DRF-YASG, но не могу понять, как настроить его так, чтобы он отображал представления, требующие аутентификации. Ниже приведена конфигурация. schema_view = get_schema_view( openapi.Info( title="Swagger Doc", default_version='v1', descripti…
08 фев '18 в 14:25
2 ответа

Сериализация полей модели во вложенный объект /dict

Представьте себе следующую модель: class Person(models.Model): name = models.CharField() address_streetname = models.CharField() address_housenumber = models.CharField() address_zip = models.CharField() У меня есть рамки для отдыха Django ModelSeria…
08 июн '18 в 08:32
0 ответов

Как настроить конечные точки API в документации Redoc API

Я использую redoc в django==2.0 для документирования некоторых django API. Я заметил, что по умолчанию redoc будет называть конечные точки автоматически, как вы можете видеть на изображении ниже с левой стороны. Скорее всего, я не хочу использовать …
28 мар '19 в 08:20
2 ответа

Как исключить параметр пути id в swagger-ui в DRF-YASG для DRF и DJANGO

Я использую DRF-YASG для документирования API в Swagger и хочу настроить / исключить некоторые поля, показанные в параметрах Я работаю над проектом с Django 2.1.7, DRF 3.9.2 и DRF-YASG 1.14.0. Итак, я хочу исключить идентификатор, который показан в …
23 мар '19 в 16:08
4 ответа

Как настроить схемы "HTTPS" с помощью автоматически генерируемой страницы сваггера drf-yasg?

Я знаю, что в традиционном файле swamger YAML мы можем определить схемы с помощью: schemes: - http - https //OR schemes: [http, https] Однако, как я могу сделать то же самое с автоматически сгенерированной страницей drf-yasg библиотека? Теперь сгене…
08 апр '19 в 07:42
0 ответов

Документирование конечной точки DRF GET с несколькими ответами с использованием Swagger

У меня есть конечная точка GET для RESTful API, который я создаю с использованием Django. Эта конечная точка считывает три значения из строки запроса URL. Определенный параметр в строке запроса может изменить данные (включить дополнительные поля и с…
20 апр '19 в 09:57
0 ответов

Раздел отклика и тега отсутствует в swagger json

Я использую drf-yasg в одном из моих приложений. В сгенерированном swagger json отсутствует раздел ответа и тегов. Я даже проверил пример, приведенный на веб-сайте документации ( https://drf-yasg-demo.herokuapp.com/cached/swagger/?format=openapi). И…
23 апр '19 в 06:48
0 ответов

Как создать схему для фильтра множественного выбора?

В нашем API у нас есть конечная точка для списка местоположений. Мы разрешаем фильтрацию по типу местоположения и разрешаем несколько значений для этого фильтра. Например: GET /location/?type=hotel&type=airport Для фильтрации мы используем djang…
23 апр '19 в 19:27