Ръководство за начинаещи за GraphQL

Един от най-често обсъжданите термини днес е API. Много хора не знаят точно какво е API. По принцип, API означава интерфейс за програмиране на приложения. Както казва името, това е интерфейс, с който хората - разработчици, потребители, потребители - могат да взаимодействат с данни.

Можете да мислите за API като барман. Питате бармана за питие и те ви дават това, което сте искали. Просто. И така, защо това е проблем?

От началото на модерната мрежа изграждането на API не е толкова трудно, колкото звучи. Но API за учене и разбиране беше. Разработчиците формират по-голямата част от хората, които ще използват вашия API за изграждане на нещо или просто консумиране на данни. Така че вашият API трябва да бъде възможно най-изчистен и интуитивен. Добре проектиран API е много лесен за използване и обучение. Освен това е интуитивно, добре е да имате предвид, когато започвате да проектирате своя API.

Отдавна използваме REST за изграждане на API. Заедно с това идват и някои проблеми. Когато изграждате API с помощта на REST дизайн, ще се сблъскате с някои проблеми като:

1) ще имате много крайни точки

2) за разработчиците ще бъде много по-трудно да научат и разберат вашия API

3) има прекомерно и недостатъчно извличане на информация

За да реши тези проблеми, Facebook създаде GraphQL. Днес мисля, че GraphQL е най-добрият начин за изграждане на API. Тази статия ще ви каже защо трябва да започнете да го научавате още днес.

В тази статия ще научите как работи GraphQL. Ще ви покажа как да създадете много добре проектиран, ефективен и мощен API с помощта на GraphQL.

Вероятно вече сте чували за GraphQL, тъй като много хора и компании го използват. Тъй като GraphQL е с отворен код, неговата общност стана огромна.

Сега е време да започнете да научавате на практика как работи GraphQL и всичко за неговата магия.

Какво е GraphQL?

GraphQL е език за заявки с отворен код, разработен от Facebook. Той ни предоставя по-ефективен начин за проектиране, създаване и използване на нашите API. По принцип това е заместителят на REST.

GraphQL има много функции, като:

  1. Вие пишете данните, които искате, и получавате точно тези, които искате. Няма повече прекалено извличане на информация, както сме свикнали с REST.
  2. Дава ни една крайна точка , не повече версия 2 или версия 3 за същия API.
  3. GraphQL е силно типизиран и с това можете да проверите заявка в системата тип GraphQL преди изпълнение. Помага ни да изградим по-мощни API.

Това е основно въведение в GraphQL - защо е толкова мощен и защо придобива голяма популярност в наши дни. Ако искате да научите повече за това, препоръчвам ви да посетите уебсайта GraphQL и да го проверите.

Приготвяме се да започнем

Основната цел в тази статия не е да научим как да настроим GraphQL сървър, така че засега не навлизаме дълбоко в това. Целта е да научим как GraphQL работи на практика, така че ще използваме GraphQL сървър с нулева конфигурация, наречен ☄️ Graphpack.

За да стартираме нашия проект, ще създадем нова папка и можете да й дадете име, каквото искате. Ще го кръстя graphql-server:

Отворете терминала си и напишете:

mkdir graphql-server

Сега трябва да имате инсталирани npm или прежда във вашата машина. Ако не знаете какво са това, npm и yarn са мениджъри на пакети за езика за програмиране JavaScript. За Node.js мениджърът на пакети по подразбиране е npm .

Във вашата създадена папка напишете следната команда:

npm init -y

Или ако използвате прежда:

yarn init 

npm ще създаде package.jsonфайл за вас и всички зависимости, които сте инсталирали, и вашите команди ще бъдат там.

Така че сега ще инсталираме единствената зависимост , която ще използваме.

☄️Graphpack ви позволява да създадете GraphQL сървър с нулева конфигурация . Тъй като тепърва започваме с GraphQL, това ще ни помогне много да продължим и да научим повече, без да се притесняваме за конфигурацията на сървъра.

Във вашия терминал, във вашата основна папка, го инсталирайте по следния начин:

npm install --save-dev graphpack

Или, ако използвате прежда, трябва да отидете по следния начин:

yarn add --dev graphpack

След като Graphpack бъде инсталиран, отидете на нашите скриптове във package.jsonфайл и поставете следния код там:

"scripts": { "dev": "graphpack", "build": "graphpack build" }

Ще създадем папка с име srcи тя ще бъде единствената папка в целия ни сървър.

Създайте папка, наречена src, след това вътре в нашата папка ще създадем само три файла.

Вътре в нашата srcпапка създайте файл, наречен schema.graphql. Вътре в този първи файл поставете следния код:

type Query { hello: String }

В този schema.graphqlфайл ще бъде цялата ни схема на GraphQL. Ако не знаете какво е, ще ви обясня по-късно - не се притеснявайте.

Сега, в нашата srcпапка, създайте втори файл. Извикайте го resolvers.jsи във този втори файл поставете следния код:

import { users } from "./db"; const resolvers = { Query: { hello: () => "Hello World!" } }; export default resolvers;

Този resolvers.jsфайл ще бъде начинът, по който предоставяме инструкциите за превръщане на операция GraphQL в данни.

И накрая, във вашата srcпапка, създайте трети файл. Обадете се на това db.jsи в този трети файл поставете следния код:

export let users = [ { id: 1, name: "John Doe", email: "[email protected]", age: 22 }, { id: 2, name: "Jane Doe", email: "[email protected]", age: 23 } ];

In this tutorial we’re not using a real-world database. So this db.js file is going to simulate a database, just for learning purposes.

Now our src folder should look like this:

src |--db.js |--resolvers.js |--schema.graphql

Now, if you run the command npm run dev or, if you’re using yarn, yarn dev, you should see this output in your terminal:

You can now go to localhost:4000 . This means that we’re ready to go and start writing our first queries, mutations, and subscriptions in GraphQL.

You see the GraphQL Playground, a powerful GraphQL IDE for better development workflows. If you want to learn more about GraphQL Playground, click here.

Schema

GraphQL has its own type of language that’s used to write schemas. This is a human-readable schema syntax called Schema Definition Language (SDL). The SDL will be the same, no matter what technology you’re using — you can use this with any language or framework that you want.

This schema language its very helpful because it’s simple to understand what types your API is going to have. You can understand it just by looking right it.

Types

Types are one of the most important features of GraphQL. Types are custom objects that represent how your API is going to look. For example, if you’re building a social media application, your API should have types such as Posts, Users, Likes, Groups.

Types have fields, and these fields return a specific type of data. For example, we’re going to create a User type, we should have some name, email, and age fields. Type fields can be anything, and always return a type of data as Int, Float, String, Boolean, ID, a List of Object Types, or Custom Objects Types.

So now to write our first Type, go to your schema.graphql file and replace the type Query that is already there with the following:

type User { id: ID! name: String! email: String! age: Int }

Each User is going to have an ID, so we gave it an ID type. User is also going to have a name and email, so we gave it a String type, and an age, which we gave an Int type. Pretty simple, right?

But, what about those ! at the end of every line? The exclamation point means that the fields are non-nullable, which means that every field must return some data in each query. The only nullable field that we’re going to have in our User type will be age.

In GraphQL, you will deal with three main concepts:

  1. queries — the way you’re going to get data from the server.
  2. mutations — the way you’re going to modify data on the server and get updated data back (create, update, delete).
  3. subscriptions — the way you’re going to maintain a real-time connection with the server.

I’m going to explain all of them to you. Let’s start with Queries.

Queries

To explain this in a simple way, queries in GraphQL are how you’re going to get data. One of the most beautiful things about queries in GraphQL is that you are just going to get the exact data that you want. No more, no less. This has a huge positive impact in our API — no more over-fetching or under-fetching information as we had with REST APIs.

We’re going to create our first type Query in GraphQL. All our queries will end up inside this type. So to start, we’ll go to our schema.graphql and write a new type called Query:

type Query { users: [User!]! }

It’s very simple: the usersquery will return to us an array of one or more Users. It will not return null, because we put in the ! , which means it’s a non-nullable query. It should always return something.

But we could also return a specific user. For that we’re going to create a new query called user. Inside our Query type, put the following code:

user(id: ID!): User! 

Now our Query type should look like this:

type Query { users: [User!]! user(id: ID!): User! }

As you see, with queries in GraphQL we can also pass arguments. In this case, to query for a specific user, we’re going to pass its ID.

But, you may be wondering: how does GraphQL know where get the data? That’s why we should have a resolvers.js file. That file tells GraphQL how and where it's going to fetch the data.

First, go to our resolvers.js file and import the db.js that we just created a few moments ago. Your resolvers.js file should look like this:

import { users } from "./db"; const resolvers = { Query: { hello: () => "Hello World!" } }; export default resolvers;

Now, we’re going to create our first Query. Go to your resolvers.js file and replace the hello function. Now your Query type should look like this:

import { users } from "./db"; const resolvers = { Query: { user: (parent, { id }, context, info) => { return users.find(user => user.id === id); }, users: (parent, args, context, info) => { return users; } } }; export default resolvers;

Now, to explain how is it going to work:

Each query resolver has four arguments. In the user function, we’re going to pass id as an argument, and then return the specific user that matches the passed id. Pretty simple.

In the users function, we’re just going to return the users array that already exists. It’ll always return to us all of our users.

Now, we’re going to test if our queries are working fine. Go to localhost:4000 and put in the following code:

query { users { id name email age } }

It should return to you all of our users.

Or, if you want to return a specific user:

query { user(id: 1) { id name email age } }

Now, we’re going to start learning about mutations, one of the most important features in GraphQL.

Mutations

In GraphQL, mutations are the way you’re going to modify data on the server and get updated data back. You can think like the CUD (Create, Update, Delete) of REST.

We’re going to create our first type mutation in GraphQL, and all our mutations will end up inside this type. So, to start, go to our schema.graphql and write a new type called mutation:

type Mutation { createUser(id: ID!, name: String!, email: String!, age: Int): User! updateUser(id: ID!, name: String, email: String, age: Int): User! deleteUser(id: ID!): User! }

As you can see, we’re going to have three mutations:

createUser: we should pass an ID, name, email, and age. It should return a new user to us.

updateUser: we should pass an ID, and a new name, email, or age. It should return a new user to us.

deleteUser: we should pass an ID. It should return a new user to us.

Now, go to our resolvers.js file and below the Query object, create a new mutation object like this:

Mutation: { createUser: (parent, { id, name, email, age }, context, info) => { const newUser = { id, name, email, age }; users.push(newUser); return newUser; }, updateUser: (parent, { id, name, email, age }, context, info) => { let newUser = users.find(user => user.id === id); newUser.name = name; newUser.email = email; newUser.age = age; return newUser; }, deleteUser: (parent, { id }, context, info) => { const userIndex = users.findIndex(user => user.id === id); if (userIndex === -1) throw new Error("User not found."); const deletedUsers = users.splice(userIndex, 1); return deletedUsers[0]; } }

Now, our resolvers.js file should look like this:

import { users } from "./db"; const resolvers = { Query: { user: (parent, { id }, context, info) => { return users.find(user => user.id === id); }, users: (parent, args, context, info) => { return users; } }, Mutation: { createUser: (parent, { id, name, email, age }, context, info) => { const newUser = { id, name, email, age }; users.push(newUser); return newUser; }, updateUser: (parent, { id, name, email, age }, context, info) => { let newUser = users.find(user => user.id === id); newUser.name = name; newUser.email = email; newUser.age = age; return newUser; }, deleteUser: (parent, { id }, context, info) => { const userIndex = users.findIndex(user => user.id === id); if (userIndex === -1) throw new Error("User not found."); const deletedUsers = users.splice(userIndex, 1); return deletedUsers[0]; } } }; export default resolvers;

Now, we’re going to test if our mutations are working fine. Go to localhost:4000 and put in the following code:

mutation { createUser(id: 3, name: "Robert", email: "[email protected]", age: 21) { id name email age } }

It should return a new user to you. If you want to try making new mutations, I recommend you to try for yourself! Try to delete this same user that you created to see if it’s working fine.

Finally, we’re going to start learning about subscriptions, and why they are so powerful.

Subscriptions

As I said before, subscriptions are the way you’re going to maintain a real-time connection with a server. That means that whenever an event occurs in the server and whenever that event is called, the server will send the corresponding data to the client.

By working with subscriptions, you can keep your app updated to the latest changes between different users.

A basic subscription is like this:

subscription { users { id name email age } }

You will say it’s very similar to a query, and yes it is. But it works differently.

When something is updated in the server, the server will run the GraphQL query specified in the subscription, and send a newly updated result to the client.

We’re not going to work with subscriptions in this specific article, but if you want to read more about them click here.

Conclusion

As you have seen, GraphQL is a new technology that is really powerful. It gives us real power to build better and well-designed APIs. That’s why I recommend you start to learn it now. For me, it will eventually replace REST.

Thanks for reading the article.

Follow me on Twitter!

Follow me on GitHub!

I’m looking for a remote opportunity, so if have any I’d love to hear about it, so please contact me at my Twitter!