Графен-Джанго динамически создает документацию API?
Я рассматриваю возможность использования GraphQL с бэкэнд-сервисом Django, но не могу найти много информации относительно документации API. Мне нужно какое-то решение для динамической генерации документации, например, как в npm graphql-docs, с результатом, аналогичным API-документам GitHub.
Реально ли это сделать с графен-джанго? Если нет, что является хорошей альтернативой для среды Python?
1 ответ
Да, это очень легко сделать с помощью GraphiQL, который встроен в Graphene.
Инструкции о том, как интегрировать это с графеном, находятся здесь в документации к графен-питону. --- в основном вам нужно добавить параметр graphiql=True
при настройке маршрута API в вашем urls.py
файл.
После того, как он настроен, перейдите к конечной точке API в браузере и увидите красивый интерфейс для отправки вызовов API, получения ответов API и чтения документации как для запросов, так и для мутаций. Документация изначально скрыта справа до тех пор, пока вы не нажмете ссылку "