Graphql documentation

Open
#2,310 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
graphql
Domain
api, documentation

Research direction

Compare the GraphQL custom queries and custom mutations sections with the Workflow of the resolvers section and the Extending API Platform documentation linked in the issue. First verify the current guidance around DTO, Processor, Provider, and resolvers, then update the documentation so the recommended approach is clear and the resolver approach is presented as an alternative. Done means the sections consistently reflect the agreed best practice.

Written by the indexing model from the issue text.

Description

The Graphql support part of the documentation recommends to use resolvers for custom queries and mutations.

At the same time, the beginning of the Workflow of the resolvers part recommends to see Extending API Platform documentation for more information.

The last part seems more relevant to me and more up-to-date with nowadays best pratices. I'm willing to rewrite this part using DTO, Processor and Provider to follow API Platform docs, and let the Resolver part as an alternate way to do (but not the first one). Before that, I would like to be sure if it the way to go. Can someone confirm ?

Thanks

Dominant language
No language data
Stars
181
Forks
1.1k
Avg merge
1d 10h
Merged PRs (30d)
24

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from api-platform/docs

All issues in api-platform/docs

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.