https://github.com/kauanslr/graphthing
GraphQL client to test your Laravel endpoints or post to external sites and also test it response.
https://github.com/kauanslr/graphthing
graphql laravel laravel-testing php php-tools testing-tools
Last synced: 2 months ago
JSON representation
GraphQL client to test your Laravel endpoints or post to external sites and also test it response.
- Host: GitHub
- URL: https://github.com/kauanslr/graphthing
- Owner: kauanslr
- Created: 2019-04-25T18:38:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T20:13:40.000Z (about 4 years ago)
- Last Synced: 2025-03-28T22:35:23.758Z (3 months ago)
- Topics: graphql, laravel, laravel-testing, php, php-tools, testing-tools
- Language: PHP
- Homepage:
- Size: 18.6 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphThing
---
## Instalação - PT-BR
### Composer
Para instalar adicione o seguinte código em seu ```composer.json```
```json
{
"require": {
"kauanslr/graphthing": "^0"
}
}
```
Depois execute ```$ composer update```
ou apenas execute ```$ composer require --dev kauanslr/graphthing```
## Utilização
Suporte para endpoints externos
___
```php
use Kauanslr\GraphThing\Traits\MakeGraphQLRequests;
class TestMyGraphQL extends TestCase
{
use MakeGraphQLRequests;
/** @var Endpoint */
protected $endpoint = '/your_graphql_endpoint' //Default '/graphql';
public function test_my_first_mutation_endpoint() {
// Parametros para mutação
$params = [
'field' => 'My first endpoint test',
];
// Campos para serem retornados
$query = ['field_1','field_2', 'field_3'];
// Campos retornados pela query
$fields = $this->graphqlMutate('mutationName', $params, $query);
// Verifica se todos os campos solicitados foram retornados
$this->assertGraphQLFields($fields);
}
public function test_my_sub_queries_endpoint() {
// Os parâmetros para a query principal
$queryParams = [];
// Campos para serem retornados
$query = [
'field_1',
'field_2',
'subQueryName' => [
'params' => [
'sub_query_param' => 'value'
],
'sub_field_1',
'sub_field_2',
'sub_field_3',
]
];
// Campos retornados pela query
$fields = $this->graphqlQuery('queryName', $params, $query, $headers);
// Verifica se todos os campos solicitados foram retornados
$this->assertGraphQLFields($fields);
}
}
```
Também é possível utilizar a interface padrão do Laravel para Request Testing:
```php
use Kauanslr\GraphThing\Traits\MakeGraphQLRequests;
class TestMyGraphQL extends TestCase
{
use MakeGraphQLRequests;
/** @var Endpoint */
protected $endpoint = '/your_graphql_endpoint' //Default '/graphql';
public function test_my_first_mutation_endpoint() {
// Parametros para mutação
$params = [];
// Campos para serem retornados
$query = ['field_1'];
// Campos retornados pela query
$fields = $this->graphqlMutate('mutationName', $params, $query);
// Retorna uma instancia de \Illuminate\Foundation\Testing\TestResponse
$response = $this->graphql->getResponse();
$response->assertStatusCode(403);
}
}
```
---
## Installation - EN
### Composer
Just add the bellow code to your ```composer.json```
```json
{
"require": {
"kauanslr/graphthing": "^0"
}
}
```
And run ```$ composer update```
or just run ```$ composer require --dev kauanslr/graphthing```
## Using
Support to external endpoints
___
```php
use Kauanslr\GraphThing\Traits\MakeGraphQLRequests;
class TestMyGraphQL extends TestCase
{
use MakeGraphQLRequests;
/** @var Endpoint */
protected $endpoint = '/your_graphql_endpoint' //Default '/graphql';
public function test_my_first_mutation_endpoint() {
// MUtation parameters
$params = [
'field' => 'My first endpoint test',
];
// To return fields
$query = ['field_1','field_2', 'field_3'];
// Get the query result
$fields = $this->graphqlMutate('mutationName', $params, $query);
// Check if requested fields is was returned
$this->assertGraphQLFields($fields);
}
public function test_my_sub_queries_endpoint() {
// Principal query parameters
$queryParams = [];
// Requesting fields
$query = [
'field_1',
'field_2',
'subQueryName' => [
'params' => [
'sub_query_param' => 'value'
],
'sub_field_1',
'sub_field_2',
'sub_field_3',
]
];
// Get query results
$fields = $this->graphqlQuery('queryName', $params, $query, $headers);
// Check if requested fields is was returned
$this->assertGraphQLFields($fields);
}
}
```
Is also possible to use the Laravel Request testing interface:
```php
use Kauanslr\GraphThing\Traits\MakeGraphQLRequests;
class TestMyGraphQL extends TestCase
{
use MakeGraphQLRequests;
/** @var Endpoint */
protected $endpoint = '/your_graphql_endpoint' //Default '/graphql';
public function test_my_first_mutation_endpoint() {
// Mutation parameters
$params = [];
// Query fields
$query = ['field_1'];
// Execute mutation
$fields = $this->graphqlMutate('mutationName', $params, $query);
//Reutur \Illuminate\Foundation\Testing\TestResponse instance
$response = $this->graphql->getResponse();
$response->assertStatusCode(403);
}
}
```