Встречается на собеседованиях • сегодня

Приходилось ли писать документацию в Swagger

Да, приходилось. Для документирования API в Swagger (OpenAPI) обычно использую библиотеку drf-yasg или drf-spectacular для Django REST Framework.

Пример с drf-yasg:

python
from drf_yasg import openapi
from drf_yasg.views import get_schema_view

schema_view = get_schema_view(
    openapi.Info(
        title="API Documentation",
        default_version='v1',
        description="Test description",
    ),
    public=True,
)

urlpatterns = [
path('swagger/', schema_view.with_ui('swagger', cache_timeout=0)),
]

text

Также можно добавлять аннотации к методам:  
```python
@swagger_auto_schema(
    operation_description="Получить список пользователей",
    responses={200: UserSerializer(many=True)}
)
def list(self, request):
    ...

Плюсы:

  • Автоматическая генерация документации
  • Интерактивный UI для тестирования
  • Поддержка авторизации и примеров запросов

Минусы:

  • Требует настройки
  • Не всегда корректно работает с кастомной логикой
Sophi
Софи собрала все вопросы. Тренируйся и получай
офферы быстрее!
Попробовать бесплатноArrow

Следующий вопрос

Это единственный вопрос по вашему фильтру

как отвечать на вопрос
пример собеседования
фреймворки на собеседовании
типичные вопросы junior
интервью вопросы и ответы