Соглашение об использовании направляющих и графических оболочек

Question

Я начинаю погружаться в graphql, создавая свой первый API с Rails. У меня тонны вопросов, касающихся стандартов и соглашений.

Например, я заметил, что гем graphql по умолчанию требует, чтобы поля передавались в CammelCase, когда на самом деле, когда я использовал для сборки RESTful API в Rails, я всегда получал аргументы в snake_case.

Так что мне было интересно, CammelCase это соглашение для Graphql? Должен ли я использовать его в своем API? Все мои тесты подтвердят, что ответы тоже в случае змеи, верно?

Answer 1

Конечно, это зависит от вас и вашего приложения, и некоторые библиотеки будут автоматически конвертировать в и из camelCase, но при выборе сайта Правила GraphQL настоятельно рекомендуем вам просто взять на себя обязательство использовать camelCase для всех GraphQL. поля и аргументы, а затем конвертируйте их в поля camel_case в Ruby, где это необходимо.

С веб-сайта Правил GraphQL веб-сайт:

Указанные здесь правила и рекомендации Это были результаты 3-летнего опыта использования GraphQL как на внешней стороне, так и на внутренней стороне. Мы также включили рекомендации и опыт Калеба Мередита (автора PostGraphQL, бывшего сотрудника Facebook) и инженеров Shopify.

1. Правила именования

   1.1. Используйте camelCase для GraphQL-полей и аргументов.

   1.2. Используйте UpperCamelCase для GraphQL-типов.

   1.3. Используйте CAPITALIZED_WITH_UNDERSCORES для именования ENUM-типов.

Я немного sh немного, что я следовал за ними для некоторых прошлых проектов, но эй, они все еще работают нормально, хотя :), но в некоторых случаях мы столкнулись с некоторыми несоответствиями и решили преобразовать некоторые поля.