Download the PHP package ufree/laravel-graphql without Composer
On this page you can find all versions of the php package ufree/laravel-graphql. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-graphql
Differences from official package
This version has been optimized for performance, and I keep up with the latest version of the webonyx library. This version uses a TypeRegistry
class inside the schema registration method to lazy load types as they are needed. This has increased performance in application with 500+ types registered by over 50%. I also stopped the unused TypeAdded
event from firing, which also increased performance significantly.
The usage of the TypeRegistry
complicates the library to a degree - you must now publish the path to your custom scalars directory and namespace in the graphql.php
configuration file. When creating custom scalars, your type
function must be configured as follows:
It's important that anywhere you reference a GraphQL, you always call it with GraphQL::type
rather than instantiating the class, as this will hook into the TypeRegistry
class. If you don't do this, you'll get schema errors.
Laravel GraphQL
Use Facebook GraphQL with Laravel 5 or Lumen. It is based on the PHP implementation here. You can find more information about GraphQL in the GraphQL Introduction on the React blog or you can read the GraphQL specifications. This is a work in progress.
This package is compatible with Eloquent model (or any other data source). See the example below.
To use laravel-graphql with Relay, check the feature/relay branch.
Installation
Version 1.0 is released. If you are upgrading from older version, you can check Upgrade to 1.0.
Dependencies:
1- Require the package via Composer in your composer.json
.
2- Run Composer to install or update the new requirement.
or
Laravel >= 5.5.x
1- Publish the configuration file
2- Review the configuration file
Usage
- Schemas
- Creating a query
- Creating a mutation
- Adding validation to mutation
Advanced Usage
- Query variables
- Query nested resource
- Enums
- Interfaces
- Custom field
- Eager loading relationships
Schemas
Starting from version 1.0, you can define multiple schemas. Having multiple schemas can be useful if, for example, you want an endpoint that is public and another one that needs authentication.
You can define multiple schemas in the config:
Or you can add schema using the facade:
Afterwards, you can build the schema using the facade:
Or you can request the endpoint for a specific schema
Creating a query
First you need to create a type.
Add the type to the config/graphql.php
configuration file
You could also add the type with the GraphQL
Facade, in a service provider for example.
Then you need to define a query that returns this type (or a list). You can also specify arguments that you can use in the resolve method.
If any part of the query has a default value, you can define this in the args()
function by including defaultValue
as an array key in one of the arguments, and setting the value to the default value.
For example, if you had an optional argument in your query to include_deleted_users
and the default value should be false
, then you could edit the args()
function as shown below:
You can also include descriptions for query fields by adding a description
array key - this will be shown in the schema, and picked up by tools like GraphiQL.
Add the query to the config/graphql.php
configuration file
And that's it. You should be able to query GraphQL with a request to the url /graphql
(or anything you choose in your config). Try a GET request with the following query
input
For example, if you use homestead:
Creating a mutation
A mutation is like any other query, it accepts arguments (which will be used to do the mutation) and return an object of a certain type.
For example a mutation to update the password of a user. First you need to define the Mutation.
As you can see in the resolve
method, you use the arguments to update your model and return it.
You then add the mutation to the config/graphql.php
configuration file
You should then be able to use the following query on your endpoint to do the mutation.
if you use homestead:
Adding validation to mutation
It is possible to add validation rules to mutation. It uses the laravel Validator
to performs validation against the args
.
When creating a mutation, you can add a method to define the validation rules that apply by doing the following:
Alternatively you can define rules with each args
When you execute a mutation, it will returns the validation errors. Since GraphQL specifications define a certain format for errors, the validation errors messages are added to the error object as a extra validation
attribute. To find the validation error, you should check for the error with a message
equals to 'validation'
, then the validation
attribute will contain the normal errors messages returned by the Laravel Validator.
All versions of laravel-graphql with dependencies
illuminate/support Version 5.5.*|5.6.*|5.7.*|5.8.*
webonyx/graphql-php Version dev-master as 0.12.6