graphene-django是否动态创建API文档?

时间:2018-02-02 21:28:38

标签: django graphql graphene-python

我正在考虑将GraphQL与Django后端服务一起使用,但我找不到有关API文档的更多信息。我需要一些动态生成文档的解决方案,可能类似于npm的graphql-docs,结果类似于GitHub's API docs

使用graphene-django完成是否可行?如果没有,什么是python环境的一个很好的选择?

1 个答案:

答案 0 :(得分:3)

是的,使用嵌入到Graphene中的GraphiQL非常容易。

如何将其与石墨烯结合的说明是here in the graphene-python documentation。 ---基本上你需要在graphiql=True文件中设置API路由时添加参数urls.py

设置完成后,如果在浏览器中转到API端点,您将看到一个很好的界面,用于发送API调用,获取API响应以及读取查询和突变的文档。文档最初隐藏在右侧,直到您单击“< Docs”链接。