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

Question

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

用graphene-django完成是否可行？如果没有，python 环境有什么好的选择？

Answer 1

是的，使用嵌入到 Graphene 中的GraphiQL很容易做到这一点。

有关如何将其与 Graphene 集成的说明，请参见 graphene-python 文档。--- 基本上你需要graphiql=True在文件中设置 API 路由时添加参数urls.py。

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