javascript - 如何向“GraphQL 模式语言”中的字段添加描述

Question

我有一个 graphql 模式，其中的一个片段如下所示：

type User {
    username: String!
    password: String!
}

在 graphiql 中，有一个描述字段，但它总是说“自我描述”。如何向架构添加描述？

Answer 1

如果您使用的是 GraphQL.js 版本 0.7.0 或更高版本，您可以直接在要描述的字段、类型或参数之前添加注释。例如：

# A type that describes the user
type User {
     # The user's username, should be typed in the login field.
     username: String!
     # The user's password.
     password: String!
}

在版本 0.7.0 以下，无法在模式语言中添加描述。

更新：从v0.12.3版本开始，您应该使用字符串文字

"""
A type that describes the user. Its description might not 
fit within the bounds of 80 width and so you want MULTILINE
"""
type User {
     "The user's username, should be typed in the login field."
     username: String!
     "The user's password."
     password: String!

}

Answer 2

这是一个很好的问题！实际上在graphql世界上有一段伟大的历史。

回购中有多个问题、讨论和拉取请求graphql-js，试图讨论可能的语法，因为许多社区成员认为这是需要的。感谢 Lee Byron 和这个 Pull Request，我们实际上可以使用传统的注释向模式语言添加描述。

例如，

// Grab some helpers from the `graphql` project
const { buildSchema, graphql } = require('graphql');

// Build up our initial schema
const schema = buildSchema(`
schema {
  query: Query
}

# The Root Query type
type Query {
  user: User
}

# This is a User in our project
type User {
  # This is a user's name
  name: String!

  # This is a user's password
  password: String!
}
`);

而且，如果我们使用graphql的是比 更新的0.7.0，注释实际上会变成字段或类型的描述。我们可以通过在我们的模式上运行自省查询来验证这一点：

const query = `
{
  __schema {
    types {
        name
        description,
        fields {
            name
            description
        }
    }
  }
}
`;

graphql(schema, query)
  .then((result) => console.log(result));

这会给我们一个看起来像这样的结果：

{
  "data": {
    "__schema": {
      "types": [
        {
          "name": "User",
          "description": "This is a User in our project",
          "fields": [
            {
              "name": "name",
              "description": "This is a user's name"
            },
            {
              "name": "password",
              "description": "This is a user's password"
            }
          ]
        },
      ]
    }
  }
}

并向我们​​展示了#评论被合并为我们放置它们的字段/评论的描述。

希望有帮助！

Answer 3

如果您使用的是Java实现......

对于graphql-java采用模式优先方法的 7.0 版（撰写本文时的最新版本），您可以在字段、类型或参数上方 使用注释。

从7.0 版开始，字符串文字不是有效的语法。