GraphQL：从 SDL 文件生成静态文档答案

【问题标题】：GraphQL: Generate static documentation from SDL fileGraphQL：从 SDL 文件生成静态文档
【发布时间】：2018-07-24 09:34:39
【问题描述】：

NPM 库graphql-docs 将从针对 API 服务器的成功架构自省调用静态生成 GraphQL API 文档。

我需要类似地生成 GraphQL API 文档，但基于 SDL 文件而不是自省调用。

我知道我可以在构建时从我的 SDL 生成服务器存根并对此进行反省，但这似乎有点矫枉过正。

是否有任何语言的库或工具链使从 SDL 文件生成文档变得简单？

【问题讨论】：

FWIW，如果你最终选择了 graphql-docs，我有一个 fork 可以在这里提供更完整的解决方案：github.com/danielrearden/graphql-docs
我们可以使用graphql-docs向生成的文件添加示例查询和变异请求和响应吗？最近我安装并使用了 graphql-docs 并且可以生成文件，但是这些文件只有查询、突变名称和对象属性的描述等。我还需要添加一些示例查询和响应

【解决方案1】：

我之前搞过graphdoc，它可以从SDL 文件、JSON 甚至graphql-tools 的executableSchema 生成静态文档。我认为没有很多其他工具可供使用，因为大多数团队只是依赖 GraphiQL 或 GraphQL Playground 来满足他们的文档需求。

【讨论】：

【解决方案2】：

我建议https://github.com/2fd/graphdoc 生成 GraphQL 端点的静态文档。

【讨论】：