質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
GraphQL

GraphQL は、アプリケーション・プログラミング・インタフェース (API) 向けのクエリ言語およびサーバーサイドランタイムです。APIの速度、柔軟性、開発者にとっての使いやすさを向上させるために設計され、データを複数のデータソースから取得するリクエストを1つのAPI呼び出しで構成できます。

Q&A

解決済

1回答

2158閲覧

GraphQLにおけるinput objectの命名について

k-tokitoh

総合スコア15

GraphQL

GraphQL は、アプリケーション・プログラミング・インタフェース (API) 向けのクエリ言語およびサーバーサイドランタイムです。APIの速度、柔軟性、開発者にとっての使いやすさを向上させるために設計され、データを複数のデータソースから取得するリクエストを1つのAPI呼び出しで構成できます。

1グッド

0クリップ

投稿2020/03/05 09:15

GithubのAPI v4を参考にしつつGraphQLのスキーマ設計をしようとしていまして、1点質問させていただきます。

Githubではinput objectは{mutationName}Inputと命名する規則が存在するようです。

この命名規則について、以下の理解をしています。

  • pros: input objectとmutationの関係が明瞭になる
  • cons: 再利用性が低くなる

この理解のうえで、「prosが小さく、consが大きいのでは」と感じています。

「そのpros/consの認識は誤っている」、「他にこんなpros/consがある」などあればお教えいただきたいです。

よろしくお願いします????

補足: 「再利用性が低くなる」というデメリットについて

例えばこのリンクの例においては、Githubの命名規則には従わずに、
createMessage, updateMessageというmutationの引数に共通してMessageInputというtypeを利用することにより、再利用性を獲得しています。

しかしGithubの命名規則に従った場合、以下のようになるかと思います。

gql

1type Mutation { 2 createMessage(input: CreateMessageInput): Message 3 updateMessage(input: UpdateMessageInput): Message 4} 5 6input CreateMessageInput { 7 content: String 8 author: String 9} 10 11input UpdateMessageInput { 12 id: ID! 13 content: String 14 author: String 15}

これではinput objectが個別に作成され再利用されていないため、たとえばMessageというリソースに対して属性が追加されたときに、2つのinput objectそれぞれに修正を加えなくてはならないと思います。

ちなみに共通化するため以下のように書ければよいのですが、input objectではこの記法はサポートされていないと思っています。

gql

1interface MessageInput { 2 content: String 3 author: String 4} 5 6input CreateMessageInput implements MessageInput { # 無効な記法 7} 8 9input UpdateMessageInput implements MessageInput { # 無効な記法 10 id: ID! 11}
shinnoki👍を押しています

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

自己解決

自己解決しました。

結論「"cons: 再利用性が低くなる"について、そもそも再利用性が期待されるべきではない。よってconsは存在せず、prosのみが存在するので、"Github的命名規則"を採用するのが是である」

createMessageupdateMessageはそもそも異なる操作であり、それぞれのinputのフィールドは本質的に=常に共通するわけではない。
(例えば「updateではauthorは変更できず、contentのみを引数にとる」ということは十分にあり得る。)

そのためCreateMessageInputUpdateMessageInputは(共通の定義を再利用するのではなく)別々に、独立に定義されるべきである。

投稿2020/07/24 13:24

k-tokitoh

総合スコア15

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問