How to map a field from a Java class to a type property with a different name?

[Shpota]

I have a type definition with a filed that has underscores in its name:

type Book {
    reviews_count: Int
}

Q: Is there a possibility to use reviewsCount instead of reviews_count in Java code? (an analog of @JsonProperty from Jackson)

Note: I do not want to remap all camel case notations to type properties with underscores. It is only needed for this particular field.

[MFoster]

I believe you can use a getReviews_Count method to delegate it to the camel case property

[Shpota]

@MFoster thank you. Of course I can do this, but the point is that I don't want to. Such naming violates Java naming conventions. I would like my code to be consistent.

It would be great if I could do something like this:

@GraphqlProperty("reviews_count")
private Integer reviewsCount;

[MFoster]

Is there a reason you need to use snake case on the graphql SDL?

While snake case is not Java's convention, the GraphQL SDL is language agnostic and allows for any naming convention aside from using-dash-delimited names. I am not aware of any annotations to satisfy what you're requesting.

I'd say either align the naming conventions from the SDL to your server implementation, implement the getter or look into writing the annotation, it could be well received by the community if others are facing this challenge as well.

[Shpota]

Is there a reason you need to use snake case on the graphql SDL?

It is a legacy system used by a number of clients. I don't know why they implemented it like this in the first place, but I can't change the API definition. Right now the whole API is largely relying on camel case naming and there are 2-3 places where underscores are used.

or look into writing the annotation

Do you mean extending this Spring Boot starter with a corresponding annotation? I guess I can try. The only thing is that it would be good to agree the changes with the owners of the repository before implementing anything so that if I come up with a pull request they will be ok to accept it.

[oliemansm]

We don’t use any annotations to map schema to fields or methods. Instead this is done by graphql-java-tools. It currently looks for fields/methods in certain possible formats. So you could create a PR for that project to add support for snake case fields to be represented by camel case fields/methods.

[oliemansm]

I'll transfer this issue to graphql-java-tools since the mapping is done by that library.

[plaurina]

Ran into the same issue due to CamelCase being more conventional in Java. My main issue revolved around JWKs (Json Web Key) where the spec for it has the field "key_ops".

My POJOS are generated from a json-schema that is shared between our front and backend code bases as our contract between each layer. Otherwise I'd have put a helper method in the POJO, or an annotation, or some other method. Editing generated classes manually is of course a maintenance nightmare waiting to happen.

I have created a PR that I hope will get accepted - the FieldResolverScanner.findResolverMethod() had a 4 checks for a variety of ways to find the method give a field name. I added a 5th way, where if none of the other 4 are found, then it will convert a snake_case field name to camel case and check for a getter. ie. "key_ops" -> getKeyOps()