CATcher-org / CATcher-org/WATcher

Include documentation for the use of Postman to test GraphQL queries

Open
#433 1 comment 0 reactions 0 assignees View on GitHub
category.Feature s.ToDiscuss
Dominant language
TypeScript
Stars
10
Forks
39
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
While I was working on a new feature, I found testing and understanding the queries and parameters to be hard as we can only change them in code, run them then check the network tab.

**Describe the solution you'd like**
I decided to use Postman to test and try out different queries

Here is a simple example of testing and running using Postman

![Image](https://github.com/user-attachments/assets/8d253045-4b6c-482a-8435-60c5d6917df0)

![Image](https://github.com/user-attachments/assets/0750de89-3e18-42e7-95a8-9c34da55883a)

We will be able to test graphql queries first without having to touch any code.

**Describe alternatives you've considered**
Maybe another solution would be to use [octokit-playground](https://github.com/graphql/graphql-playground) library as we are already using octokit to run the queries

[Github Explorer](https://docs.github.com/en/graphql/overview/explorer) works great too as there is no need for any extra authentication.

**Additional context**
Perhaps having more information for testing and learning might make it easier for other contributors and encourage implementing more complex features using graphql.

Perhaps we can consider
- Postman with a collection of all the queries built-in with variables (reduce the need of having setup queries every time we want to use it)
- Github explorer, easy to use however, every query requires setting up relevant variables

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the Postman examples and the repository's GraphQL query usage described in the issue, then locate the current contributor or user documentation. Done means contributors can follow documented steps to test GraphQL queries with Postman, including variables, without changing application code; compare the alternatives mentioned, such as GitHub's GraphQL Explorer.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, postman
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.