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

Question

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

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

Answer 1

如果您使用的是Graphql.js0.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!

}