Как правильно задокументировать параметры запроса (поиск, фильтрация) Django Rest Framework?

Question

Я новичок в рендеринге документации для DRF. Я не могу понять, как правильно документировать его в коде для визуализации описания в документации. Я использую DRF Docs для этого.

Например: у меня есть маршрут, где я могу получить некоторые данные. При похожем представлении у меня есть:

search_fields = ('name', 'registration_date')

Но эти поля не имеют описания на странице документации. .

Так что я хочу добавить описания для них. Есть ли способ сделать это?

Answer 1

В основном вы ищете функцию REST "схема".смотрите здесь: REST-SCHEMA

С помощью этого инструмента вы можете медленно, но неуклюже добавлять описания ко всем полям, которые вы хотите.

Вот хорошая страница с инструкциями: Урок 7: Схемы и клиентские библиотеки