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 repo上有多个问题，讨论和请求，试图讨论这种可能的语法，因为它是社区很多成员认为需要的东西。感谢Lee Byron和this 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起，

字符串文字是不是有效语法。

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

3 个答案: