Приходилось ли писать документацию в Swagger
Python
Junior
Без компании
Приходилось ли писать документацию в Swagger
Ответы
Да, приходилось. Для документирования API в Swagger (OpenAPI) обычно использую библиотеку `drf-yasg` или `drf-spectacular` для Django REST Framework.
Пример с `drf-yasg`:
```
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)),
]
```
Также можно добавлять аннотации к методам:
```
@swagger_auto_schema(
operation_description="Получить список пользователей",
responses={200: UserSerializer(many=True)}
)
def list(self, request):
...
```
Плюсы:
- Автоматическая генерация документации
- Интерактивный UI для тестирования
- Поддержка авторизации и примеров запросов
Минусы:
- Требует настройки
- Не всегда корректно работает с кастомной логикой