Quarkus Microprofile GraphQL documentation #8967
Conversation
|
@phillip-kruger is aware that I am working on the documentation for quarkus graphql extension that he is currently working on. |
cemnura
force-pushed
the
feature/graphql_docs
branch
from
cea2473 to
9d18994
Compare
| public String name; | ||
| public Double height; | ||
| public Integer mass; | ||
| public Boolean isDarkSide; | ||
| public LightSaber lightSaber; |
There was a problem hiding this comment.
You might need getters and setters. I never tested public fields, but it might work.
There was a problem hiding this comment.
I can add setter and getters or I can add a comment line stating the setters and getters are omitted for brevity. However, that way make the documentation misleading.
I will try with public fields to see if it works and then will add setters and getters depending on that. 🙂
There was a problem hiding this comment.
I tried using public fields in the quickstart but got errors when omitting setter and getter methods. If I have understand correctly setter and getter methods must be included
in order to qualify as a field in GraphQL API.
There was a problem hiding this comment.
Yes, The spec is also not that clear on fields (microprofile/microprofile-graphql#226) and we are discussing it. We can see if we can build support for that in SmallRye. I'll add a ticket.
| ---- | ||
|
|
||
| The server will return the complete schema of the `graphQL` API. | ||
|
|
There was a problem hiding this comment.
You can maybe mention that in dev and test (and by configuration, even prod) Graphiql (UI) will be available in http://localhost:8080/graphql-ui
There was a problem hiding this comment.
Okey, sounds like a great idea 👍
There was a problem hiding this comment.
I mentioned Graphiql in the documentation. Great feature 👍
|
This goes with the extension: #9144 |
cemnura
force-pushed
the
feature/graphql_docs
branch
from
9d18994 to
1c996a2
Compare
| -DprojectGroupId=org.acme \ | ||
| -DprojectArtifactId=microprofile-graphql-quickstart \ | ||
| -DclassName="org.acme.microprofile.graphql.FilmResource" \ | ||
| -Dextensions="smallrye-graphql" |
There was a problem hiding this comment.
@phillip-kruger I am not sure of the name of the extensions. Is this correct?
There was a problem hiding this comment.
Is it not quarkus-smallrye-graphql ?
There was a problem hiding this comment.
| ---- | ||
|
|
||
| The server will return the complete schema of the `graphQL` API. | ||
|
|
There was a problem hiding this comment.
I mentioned Graphiql in the documentation. Great feature 👍
cemnura
force-pushed
the
feature/graphql_docs
branch
from
1c996a2 to
f792917
Compare
cemnura
force-pushed
the
feature/graphql_docs
branch
from
f792917 to
4c03df3
Compare
Signed-off-by: Cem Nura <[email protected]>
And also include the generated configuration reference.
gsmet
force-pushed
the
feature/graphql_docs
branch
from
4c03df3 to
55043bb
Compare
|
I rebased and fixed a bunch of stuff in a separate commit. Will merge now. |
|
Thanks! |
4 participants
Signed-off-by: Cem Nura [email protected]