【问题标题】:Graphical presentation of GraphQL schemaGraphQL 模式的图形表示
【发布时间】:2017-06-02 16:13:11
【问题描述】:

有没有办法提供 GraphQL Schema 设计的可视化图表(类似 UML)?

背景: 我已经有了一个架构设计,将被转换为 GraphQL API。但是,在开始 GraphQL 开发之前,我想创建我拥有的模式的可视化表示。图表本质上应该至少显示查询类型和关系,这将帮助开发人员了解在 GraphQL 中开发什么。

有没有办法或标准?

【问题讨论】:

  • 我不清楚你真正想要什么。您是否想要一个给出您开发的模式的图表(顺便说一下,它是一种什么样的模式)?或者你想要一个图表,给定一个 GraphQL 模式?
  • 是前者;我想创建一个给定数据库模式的图表。输出图作为 GraphQL 开发人员的输入,以了解我对 GraphQL 模式的期望(如查询类型和关系)。问题是知道是否有任何标准图表可以向 GraphQL 开发人员提供我的要求。
  • GraphQL 模式和 DB 模式不直接相互关联。 GraphQL 模式可能会扁平化许多不在数据库模式中的东西。我还没有看到你需要的那种东西。
  • 同意。感谢您分享您的观点...
  • 您可以使用任何图表工具。我个人使用的是 Omnigraffle(仅限 OSX),但您可以使用 Visio(Windows)或众多在线图表应用程序中的任何一种(例如 draw.io 等)。我只关注查询类型及其关系。总而言之,生成的 GraphQL API 有超过 200 种类型,它的图表首先帮助指导了我的 GraphQL 模式设计,并且在我构建解析器时更容易保持一切正常

标签: graphql


【解决方案1】:

Moon Modeler 支持 GraphQL Schema 的可视化定义,包括。类型、接口、枚举、输入和关系。

【讨论】:

    【解决方案2】:

    查看此工具:https://github.com/sheerun/graphqlviz

    根据我在实际 GraphQL 架构上使用它的经验,输出可能会变得非常大,但我认为它可能会满足您的要求。

    希望这会有所帮助!

    【讨论】:

    • 感谢您的回复。该工具看起来对我的其他要求很有用。但是,我目前的要求是从我知道的 DB 模式创建 GraphQL 图(我还没有 GraphQL API,它尚未开发)。我很高兴手动创建图表,但另一个问题是知道是否有任何标准可以显示 GraphQL 图。 (就像我们有类图,使用UML工具的序列图)
    • 嗯,我明白了。不幸的是,我不确定这是否有标准做法。一种选择是使用 GraphQL 模式语言编写你的模式,然后使用像 graphql-tools github.com/apollostack/graphql-tools 这样的库用空白解析器加载它。然后,您可以在其上运行 graphqlviz 工具以自动生成图表。
    • 是的,看起来是最接近此问题的解决方案。会试一试。谢谢!
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-11-11
    • 2014-05-01
    • 1970-01-01
    • 1970-01-01
    • 2018-03-15
    相关资源
    最近更新 更多