Download as PDF, PPTX
![{
conferences {
name
dates
}
}
"conferences": [
{
"name": "LonghornPHP",
"dates": "May 2 - 4, 2019"
}
]](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-10-2048.jpg)
![{
conferences {
name
speakers {
name
twitter
}
}
}
{
"conferences": [
{
"name": "LonghornPHP",
"speakers": [
{
"name": "Andrew Rota",
"twitter": "https://twitter.com/andrewrota"
}
]
}
]
}](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-11-2048.jpg)
![Types + Schemas
‣
type Conference {
name: String!
url: String!
description: String
location: String
dates: String!
# List of speakers at this conference
speakers: [Speaker]
}](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-25-2048.jpg)
![Types + Schemas
‣
‣
type Conference {
name: String!
url: String!
description: String
location: String
dates: String!
# List of speakers at this conference
speakers: [Speaker]
}
non-nullable
scalar type
list of
object
types](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-26-2048.jpg)
![Query + Mutation Types
‣
Query Mutation
‣ Root fields
entry points
type Query {
# Returns conferences
conferences: [Conference]
# Returns speakers
speakers: [Speaker]
}
root
fields
root type](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-27-2048.jpg)
![Handle queries
‣
‣ Schema
‣ GraphQL::executeQuery
$schema = new Schema([
'query' => Types::query()
]);
$result = GraphQL::executeQuery(
$schema,
$requestData['query'],
null,
$appContext,
(array)$requestData['variables']
);
$output = $result->toArray();](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-40-2048.jpg)
![Root fields
‣
fields
‣ type
resolve
use GraphQLTypeDefinitionObjectType;
use GraphQLTypeDefinitionType;
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'message' => [
'type' => Type::string(),
'resolve' => function () {
return 'hello world';
}
],
]
]);](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-42-2048.jpg)
![Fields can return objects
‣
‣
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'conferences' => [
'type' => Types::listOf(Types::conference()),
'description' => 'Returns conferences',
'resolve' => function() {
return DataSource::getConferences();
}
],
'message' => [
'type' => Type::string(),
'resolve' => function () {
return 'hello world';
}
],
]
]);](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-43-2048.jpg)
![Resolvers
‣
‣
‣
‣
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'conferences' => [
'type' => Types::listOf(Types::conference()),
'description' => 'Returns conferences',
'resolve' => function() {
return DataSource::getConferences();
}
],
'message' => [
'type' => Type::string(),
'resolve' => function () {
return 'hello world';
}
],
]
]);](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-44-2048.jpg)
![Custom object type
‣
$config = [
'name' => 'Conference',
'fields' => [
'name' => Type::nonNull(Types::string()),
'url' => Type::nonNull(Types::string()),
'location' => Types::string(),
]
];](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-48-2048.jpg)
![Custom object type
‣
‣
$config = [
'name' => 'Conference',
'fields' => [
'name' => Type::nonNull(Types::string()),
'url' => Type::nonNull(Types::string()),
'location' => Types::string(),
'speakers' => [
'type' => Types::listOf(Types::speaker()),
'resolve' => function($root) {
return DataSource::getSpeakersAtConf($root->id);
}
]
]
];](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-49-2048.jpg)
![Introspection
‣
‣
‣
{
"data": {
"__schema": {
"queryType": {
"name": "Query"
},
"types": [
{
"kind": "OBJECT",
"name": "Query",
"description": null,
"fields": [
{
"name": "conferences",
"description": "Returns a list of PHP conferences",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Conference",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
]
}
]
}
}
}](https://image.slidesharecdn.com/buildingagraphqlapiinphplonghornphp192-190503160830/75/Getting-Started-with-GraphQL-PHP-57-2048.jpg)
Uploaded byAndrew Rota
Getting Started with GraphQL && PHP
This document discusses GraphQL and its advantages over traditional REST APIs. It summarizes how GraphQL works, including defining object types and fields, writing queries and mutations, and implementing GraphQL with the graphql-php library. It also covers challenges like the N+1 problem and solutions like deferred resolvers. Overall the document provides an introduction to GraphQL concepts and how it can be used to build APIs.
More Related Content
Similar to Getting Started with GraphQL && PHP
Getting Started with GraphQL && PHP
- 1. @AndrewRota | LonghornPHP 2019
- 2. APIs are important NativeMobile Apps Web browsers (http requests from JavaScript) External API API
- 3. Native Mobile Apps Webbrowsers External API API article comment comment author author author
- 4. Native Mobile Apps Webbrowsers External API API article comment comment author
- 5. Native Mobile Apps Webbrowsers External API APIgetBlog
- 6. Challenges with APIsToday ‣ ‣ ‣
- 8. @AndrewRota Associate Director, SoftwareEngineering
- 9. “GraphQL is aquery language for APIs and a runtime for fulfilling those queries with your existing data.”
- 10. { conferences { name dates } } "conferences": [ { "name":"LonghornPHP", "dates": "May 2 - 4, 2019" } ]
- 11. { conferences { name speakers { name twitter } } } { "conferences":[ { "name": "LonghornPHP", "speakers": [ { "name": "Andrew Rota", "twitter": "https://twitter.com/andrewrota" } ] } ] }
- 12.
- 13.
- 14. GraphQL Implementations ‣ technologyagnostic ‣ ‣
- 15.
- 16. GraphQL in aweb stack QueryClient (e.g., browser, mobile app) /graphql on PHP Server response Database
- 17. GraphQL in aweb stack QueryClient (e.g., browser, mobile app) /graphql on PHP Server response Cache Service Database
- 18. GraphQL in aweb stack QueryClient (e.g., browser, mobile app) /graphql server response Cache REST Service Database PHP
- 20. Queries + Fields ‣ fields ‣ sameshape query { conferences { name dates } } query field
- 21. Fields ‣ ‣ sub-selection ‣ avoid multiple requests query{ conferences { name speakers { name } } } sub-selection
- 22. Arguments ‣ arguments each field{ conference(name: "LonghornPHP") { speakers { name } } } argument
- 23. Variables ‣ query SearchConfs($name: String){ conferences(nameFilter:$name){ name } } {"name": "LonghornPHP"}
- 24. Types + Schemas ‣ setof types
- 25. Types + Schemas ‣ typeConference { name: String! url: String! description: String location: String dates: String! # List of speakers at this conference speakers: [Speaker] }
- 26. Types + Schemas ‣ ‣ typeConference { name: String! url: String! description: String location: String dates: String! # List of speakers at this conference speakers: [Speaker] } non-nullable scalar type list of object types
- 27. Query + MutationTypes ‣ Query Mutation ‣ Root fields entry points type Query { # Returns conferences conferences: [Conference] # Returns speakers speakers: [Speaker] } root fields root type
- 28. Queries ‣ ‣ ‣ query ConferenceNamesAndDates{ conferences { name dates } } operationnameoperation type fields
- 29. Mutations ‣ ‣ mutation mutation { addSpeaker( name:"Andrew Rota", twitter: "https://twitter.com/andrewrota") { id } }
- 32. Queries from JavaScript ‣ ‣ queryConferenceNamesAndDates{ conferences { name dates } }
- 33. Lokka a simple graphqlclient library ‣ const t = new HttpTransport('/graphql'); t.send(`query ConferenceNamesAndDates{ conferences { name dates } }`).then(response => { console.log(response); });
- 34. Apollo complete data managementsolution ‣ ‣ ‣ ‣ ‣ <Query client={client} query={CONFERENCES_QUERY}> {({ loading, error, data }) => { if (loading) return 'Loading...'; if (error) return `Error!`; return ( <ul> {data.conferences.map(conference => ( <li>{conference.name}</li> ))} </ul> ); }} </Query>
- 38.
- 40. Handle queries ‣ ‣ Schema ‣GraphQL::executeQuery $schema = new Schema([ 'query' => Types::query() ]); $result = GraphQL::executeQuery( $schema, $requestData['query'], null, $appContext, (array)$requestData['variables'] ); $output = $result->toArray();
- 41.
- 42. Root fields ‣ fields ‣ type resolve useGraphQLTypeDefinitionObjectType; use GraphQLTypeDefinitionType; $queryType = new ObjectType([ 'name' => 'Query', 'fields' => [ 'message' => [ 'type' => Type::string(), 'resolve' => function () { return 'hello world'; } ], ] ]);
- 43. Fields can returnobjects ‣ ‣ $queryType = new ObjectType([ 'name' => 'Query', 'fields' => [ 'conferences' => [ 'type' => Types::listOf(Types::conference()), 'description' => 'Returns conferences', 'resolve' => function() { return DataSource::getConferences(); } ], 'message' => [ 'type' => Type::string(), 'resolve' => function () { return 'hello world'; } ], ] ]);
- 44. Resolvers ‣ ‣ ‣ ‣ $queryType = newObjectType([ 'name' => 'Query', 'fields' => [ 'conferences' => [ 'type' => Types::listOf(Types::conference()), 'description' => 'Returns conferences', 'resolve' => function() { return DataSource::getConferences(); } ], 'message' => [ 'type' => Type::string(), 'resolve' => function () { return 'hello world'; } ], ] ]);
- 45. resolve function function($root, $args,$context, ResolveInfo $info) { return DataSource::getData($root->id); } root / parent result arguments app context query AST and other meta info
- 48. Custom object type ‣ $config= [ 'name' => 'Conference', 'fields' => [ 'name' => Type::nonNull(Types::string()), 'url' => Type::nonNull(Types::string()), 'location' => Types::string(), ] ];
- 49. Custom object type ‣ ‣ $config= [ 'name' => 'Conference', 'fields' => [ 'name' => Type::nonNull(Types::string()), 'url' => Type::nonNull(Types::string()), 'location' => Types::string(), 'speakers' => [ 'type' => Types::listOf(Types::speaker()), 'resolve' => function($root) { return DataSource::getSpeakersAtConf($root->id); } ] ] ];
- 52.
- 53. Solution: deferred resolvers ‣ ‣ ‣ 'resolve'=> function($root) { SpeakerCollection::add($root->id); return new Deferred(function() use ($root) { return SpeakerCollection::get($root->id); }); }
- 54. Limiting Query Complexityand Depth ‣ ‣
- 55. Persisted Queries queryClient Server query{ conferences { name dates } } idClient Server{ id: 001 } ‣ ‣ ‣ ‣ With persisted queries:
- 57. Introspection ‣ ‣ ‣ { "data": { "__schema": { "queryType":{ "name": "Query" }, "types": [ { "kind": "OBJECT", "name": "Query", "description": null, "fields": [ { "name": "conferences", "description": "Returns a list of PHP conferences", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Conference", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ] } ] } } }
- 58. GraphiQL - inbrowser IDE for exploring GraphQL
- 59. Graphql Playground -like GraphiQL, but more features
- 60. Voyager - AnyGraphQL API as an interactive graph
- 61. PHPStorm JS GraphQLPlugin - IDE Integration
- 62. Types can beused in client-side code ‣ Apollo Codegen ‣
- 67.