Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add example of utilizing GraphQL with Litestar via Strawberry #3719

Closed
wants to merge 10 commits into from

Conversation

aarcex3
Copy link
Contributor

@aarcex3 aarcex3 commented Sep 4, 2024

Description

Add an example in the docs of how to use graphql with litestar via strawberry
Add tests for the example in test/examples/test_graphql

Question

should I add an example of a mutation query as well?

Closes

#3317

@aarcex3 aarcex3 requested review from a team as code owners September 4, 2024 18:43
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: small type/docs pr/external Triage Required 🏥 This requires triage labels Sep 4, 2024

.. code-block:: shell

pip install litestar[graphql]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is something that exists.

Copy link
Contributor Author

@aarcex3 aarcex3 Sep 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added it as an optional dependecy in the pyproject.toml file. Should I change it to pip install strawberry-graphql in the docs?

Copy link
Contributor

@Alc-Alc Alc-Alc Sep 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not in favor adding detailed examples in the first place. I would rather prefer a link to https://strawberry.rocks/docs/integrations/litestar. I will let others weigh in on if this.

edit: I am aware of the linked issue, but I just wanted to share my opinion

@provinzkraut
Copy link
Member

Closing this for now. @aarcex3 feel free to open another PR with the change @Alc-Alc suggested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation pr/external size: small Triage Required 🏥 This requires triage type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants