将自定义数据输入 GraphiQL Docs答案

【问题标题】：Entering custom data into GraphiQL Docs将自定义数据输入 GraphiQL Docs
【发布时间】：2020-02-19 23:23:25
【问题描述】：

我想使用 GraphiQL 文档来记录我的 GraphQL API。开箱即用的版本看起来已经非常有用了，但是我想通过有关权限的信息来丰富它。

我的想象是在这个

会有另一个部分，即“权限”，其中包含一些权限说明。

我的问题：这是这样做的方式吗？如果不是，如何在 GraphiQL Docs 中表达权限？如果这可能是这种方式，是否有任何工具能够做到这一点？

【问题讨论】：

【解决方案1】：

GraphiQL（或类似的工具，如 GraphQL Playground、Altair 等）中显示的内容仅限于可以通过自省模式返回的内容，这受规范指定的内容的限制。您可以向类型、字段、参数、枚举值和指令添加描述。架构本身的描述是in the works。

充其量，您可以在指定权限的字段中添加说明。如果你想让它变得活泼，你可以使用 markdown。

【讨论】：

感谢您的快速回复！人们通常如何处理这个问题？另一个文档工具？手动编写文档？相信之前一定有人遇到过这样的问题……
我怀疑是否有任何工具可以让您使用通过工具的 UI 公开的任意元数据来装饰您的架构。就像我说的，如果您的意图是注释每个字段需要哪些权限，那么使用描述是最好的选择。如果您已经使用指令来应用权限方案，那么相同的指令也可以动态修改描述。