GraphQL Example Project

The project is an example of GraphQL API implementation using Symfony 5 framework and library GraphQLBundle (vendor Overblog). The project consists of four Docker containers (php, mysql, nginx, mongodb).

Installing the application

1. Cloning the repository:

   [email protected]:Pruanik/graphql_example_project.git

2. Configuring the .env file:

   cp .env_example .env

3. Building containers:

   make build

4. Starting containers

   make up

5. Installing dependencies:

   make composer-install

6. Running the migrations and filling the fixtures:

   make init

7. Let's see the result:

   http://localhost:8080/

List of commands for project management

To build containers: make build

To install all composer dependencies: make composer-install

To start containers: make up

To start application containers if you have databases locally: up-without-databases

To run migrations and pour fixtures: make init

For stopping containers: make stop

To enter the main container with the application: make enter

Useful links

• By default the project starts on port 8080, so the link will be http://localhost:8080/
• Overblog/graphiql-bundle library is included into the project for easy testing of queries to GraphQL server. To use interactive mode you should follow the link: http://localhost:8080/graphiql
• To access the GraphQL server using a client (e.g. Postman), you should send requests to: http://localhost:8080/graphql/

Application data model schema

Application Structure

• GraphQL data schema are stored in config/graphql/types/Domain/Input and config/graphql/types/Domain/Object for mutations and objects.
• In the migration folder, the actual migrations for starting the application.
• The src/Document and src/Entity folders describe all entities for MongoDb and Mysql.
• The src/GraphQL folder contains all custom classes for building GraphQL logic for our Symfony application.
• src/Listener/ReferencesListener.php - is needed to configure relational links between entities stored in mysql and entities in MongoDb.
• The src/Model folder contains all classes of our Symfony application.
• src/Security/ApiTokenAuthenticator.php - here we implement a custom way to authenticate a user by the presence of a key in the request header.

Useful links

• Official Website
• Developer Blog
• Companies Using GraphQL
• Standards

---

• GraphQL w Symfony | Mariusz Bąk | Boldare
• Павел Черторогов — Строим GraphQL-сервер
• Александр Демченко «Graphql + Symfony» | CODEiD (11.08.2018)

---

• Comparison of API architectural styles: SOAP vs REST vs GraphQL vs RPC
• 5 reasons why you shouldn't use GraphQL
• What is the N+1 Problem in GraphQL?
• How to set up a GraphQL server with Symfony 4?
• Setting up GraphQL with PHP: Defer field resolving

---

• Getting started with GraphQL

• Solving the N+1 Problem for GraphQL through Batching

• Why is there a problem with N+1 in graphql?

• Adding a GraphQL API to your Symfony Flex application

• OverblogGraphQLBundle

• OverblogGraphQLBundle Settings