Создает ли graphene-django документацию API динамически?

Я рассматриваю возможность использования GraphQL с серверной службой Django, но не смог найти много информации о документации по API. Мне нужно какое-то решение для динамического создания документации, например, graphql-docs от npm с результат аналогичен документам API GitHub.

Возможно ли это сделать с помощью graphene-django? Если нет, то какая хорошая альтернатива среде Python?


person TheMechanic    schedule 02.02.2018    source источник


Ответы (1)


Да, это очень легко сделать с помощью GraphiQL, встроенного в Graphene.

Инструкции по интеграции этого с Graphene: здесь, в документации по graphene-python. --- в основном вам нужно добавить параметр graphiql=True при настройке маршрута API в файле urls.py.

После настройки, если перейти к конечной точке API в браузере, вы увидите удобный интерфейс для отправки вызовов API, получения ответов API и чтения документации как для запросов, так и для мутаций. Документация изначально скрыта справа, пока вы не нажмете ссылку «‹ Docs».

person Mark Chackerian    schedule 02.02.2018