我想使用 GraphiQL 文档来记录我的 GraphQL API。开箱即用的版本看起来非常有用,但是我想通过有关权限的信息来丰富它。
我的想象是在这个
将有另一个部分,即“权限”,其中包含一些权限描述。
我的问题:这是这样做的方法吗?如果不是,如何在 GraphiQL Docs 中表达权限?如果这可能是方式,是否有任何工具能够做到这一点?
我想使用 GraphiQL 文档来记录我的 GraphQL API。开箱即用的版本看起来非常有用,但是我想通过有关权限的信息来丰富它。
我的想象是在这个
将有另一个部分,即“权限”,其中包含一些权限描述。
我的问题:这是这样做的方法吗?如果不是,如何在 GraphiQL Docs 中表达权限?如果这可能是方式,是否有任何工具能够做到这一点?
GraphiQL(或类似的工具,如 GraphQL Playground、Altair 等)中显示的内容仅限于可以通过自省模式返回的内容,这受规范指定的内容的限制。您可以向类型、字段、参数、枚举值和指令添加描述。模式本身的描述正在编写中。
充其量,您可以在指定权限的字段中添加描述。如果你想让它变得活泼,你可以使用降价。