将自定义数据输入 GraphiQL Docs

Entering custom data into GraphiQL Docs

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

我的想象是在这个

将有另一个部分,即 "Permissions",其中包含一些权限说明。

我的问题:是这样做的吗?如果没有,如何在 GraphiQL 文档中表达权限?如果可以的话,是否有任何工具能够做到这一点?

GraphiQL(或 GraphQL Playground、Altair 等类似工具)中显示的内容仅限于通过模式自省可以返回的内容,这受规范指定的内容限制。您可以为类型、字段、参数、枚举值和指令添加描述。模式本身的描述是 .

充其量,您可以在指定权限的字段中添加说明。如果你想让它更有趣,你可以使用 markdown。