Rails 和 graphql 大小写约定

Rails and graphql casing convention

我开始深入研究 graphql,用 Rails 构建我的第一个 API。我有很多关于标准和惯例的问题。

例如,我注意到 gem graphql 默认情况下需要在 CammelCase 中传递字段,而实际上当我以前在 RESTful API 中构建时Rails 我总是收到 snake_case 中的参数。

所以我想知道,CammelCase 是 Graphql 的约定吗?我还应该在 API 中使用它吗?我所有的测试都会断言响应也是蛇形的,对吗?

这当然取决于您和您的应用程序,一些库会自动与驼峰式大小写相互转换,但如果有选择,GraphQL Rules website 强烈建议您只承诺对所有 GraphQL 字段使用驼峰式大小写,并且参数,然后在必要时将它们转换为 Ruby 中的 camel_case 字段。

来自 GraphQL Rules website 网站:

Rules and recommendations mentioned here were the results of 3 years' experience of using GraphQL both on the frontend and backend sides. We also include the recommendations and experience of Caleb Meredith (PostGraphQL author, Facebook ex-employee) and Shopify engineers.

  1. Naming rules

    1.1. Use camelCase for GraphQL-fields and arguments.

    1.2. Use UpperCamelCase for GraphQL-types.

    1.3. Use CAPITALIZED_WITH_UNDERSCORES to name ENUM-types.

我有点希望我在过去的一些项目中遵循了这些,但是嘿,它们仍然 运行 不过还不错 :),但是在我们偶尔会遇到一些不一致和选择转换一些字段。