1. ホーム
  2. javascript

"GraphQL schema language "でフィールドに説明を追加する方法

2023-09-12 07:41:11

質問

私は、以下のような断片的なgraphqlスキーマを持っています。

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

Graphiqlでは、descriptionフィールドがありますが、常に"self-descriptive"と表示されます。スキーマに記述を追加するにはどうしたらよいでしょうか?

どのように解決するのですか?

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 以下では、スキーマ言語内に記述を追加することはできません。

UPDATE: バージョン 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!

}