„GraphQL“ vadovas pradedantiesiems

Vienas iš dažniausiai šiandien aptariamų terminų yra API. Daugelis žmonių tiksliai nežino, kas yra API. Iš esmės API reiškia „ Application Programming Interface“. Tai, kaip sako pavadinimas, sąsaja, su kuria žmonės - kūrėjai, vartotojai, vartotojai - gali sąveikauti su duomenimis.

Galite galvoti apie API kaip apie barmeną. Paprašai barmeno išgerti, o jie tau duoda tai, ko norėjai. Paprasta. Tai kodėl tai problema?

Nuo modernaus interneto pradžios API kūrimas nebuvo toks sunkus, kaip atrodo. Bet mokytis ir suprasti API buvo. Kūrėjai sudaro daugumą žmonių, kurie naudos jūsų API ką nors kurti ar tiesiog suvartoti duomenis. Taigi jūsų API turėtų būti kuo švaresnė ir intuityvesnė. Gerai sukurtą API yra labai lengva naudoti ir išmokti. Tai taip pat intuityvus dalykas, kurį verta nepamiršti, kai pradedate kurti savo API.

API kūrėme jau seniai naudodami „REST“. Kartu su tuo kyla keletas problemų. Kurdami API naudodami REST dizainą, susidursite su šiomis problemomis:

1) turėsite daug galinių taškų

2) kūrėjams bus daug sunkiau išmokti ir suprasti jūsų API

3) yra per daug ir nepakankamai gaunama informacija

Norėdami išspręsti šias problemas, „Facebook“ sukūrė „GraphQL“. Šiandien manau, kad „GraphQL“ yra geriausias būdas kurti API. Šis straipsnis jums pasakys, kodėl turėtumėte pradėti jo mokytis šiandien.

Šiame straipsnyje jūs sužinosite, kaip veikia „GraphQL“. Aš jums parodysiu, kaip sukurti labai gerai suprojektuotą, efektyvią, galingą API naudojant „GraphQL“.

Jūs tikriausiai jau girdėjote apie „GraphQL“, nes daugelis žmonių ir kompanijų jį naudoja. Kadangi „GraphQL“ yra atviro kodo programa, jos bendruomenė išaugo didžiulė.

Dabar atėjo laikas pradėti praktiškai išmokti, kaip veikia „GraphQL“, ir apie jo magiją.

Kas yra „GraphQL“?

GraphQL yra „Facebook“ sukurta atviro kodo užklausų kalba. Tai leidžia mums efektyviau kurti, kurti ir vartoti mūsų API. Iš esmės tai yra REST pakaitalas.

„GraphQL“ turi daugybę funkcijų, tokių kaip:

  1. Jūs parašote norimus duomenis ir gausite būtent tuos duomenis, kurių norite. Nebereikia per daug gauti informacijos, kaip mes įpratome su REST.
  2. Tai suteikia mums vieną galutinį tašką , ne daugiau tos pačios API 2 ar 3 versijos.
  3. „GraphQL“ yra labai tipiškas, todėl prieš vykdydami galite patvirtinti užklausą „GraphQL“ tipo sistemoje. Tai padeda mums sukurti galingesnes API.

Tai yra pagrindinis „GraphQL“ įvadas - kodėl jis toks galingas ir kodėl šiomis dienomis sulaukia didelio populiarumo. Jei norite apie tai sužinoti daugiau, rekomenduoju apsilankyti „GraphQL“ svetainėje ir ją patikrinti.

Darbo pradžia

Pagrindinis šio straipsnio tikslas nėra išmokti nustatyti „GraphQL“ serverį, todėl kol kas į tai nesigiliname. Tikslas yra sužinoti, kaip „GraphQL“ veikia praktiškai, todėl naudosime nulinės konfigūracijos „GraphQL“ serverį, vadinamą „Graphpack“.

Norėdami pradėti savo projektą, mes sukursime naują aplanką ir galėsite jį pavadinti taip, kaip norite. Aš tai pavadinsiu graphql-server:

Atidarykite terminalą ir įveskite:

mkdir graphql-server

Dabar kompiuteryje turėtumėte įdiegti npm arba siūlus . Jei nežinote, kas tai yra, npm ir verpalai yra „JavaScript“ programavimo kalbos paketų tvarkytuvai. Node.js numatytasis paketų tvarkytuvas yra npm .

Sukurto aplanko viduje įveskite šią komandą:

npm init -y

Arba, jei naudojate siūlus:

yarn init 

„npm“ sukurs package.jsonjums failą, o ten bus visos jūsų įdiegtos priklausomybės ir komandos.

Taigi dabar mes įdiegsime vienintelę priklausomybę , kurią naudosime.

☄️Graphpack leidžia jums sukurti „GraphQL“ serverį su nuline konfigūracija . Kadangi mes tik pradedame nuo „GraphQL“, tai mums labai padės tęsti ir sužinoti daugiau, nesijaudindami dėl serverio konfigūracijos.

Terminale, šakniniame aplanke, įdiekite jį taip:

npm install --save-dev graphpack

Arba, jei naudojate siūlus, turėtumėte elgtis taip:

yarn add --dev graphpack

Įdiegę „Graphpack“, eikite į mūsų scenarijus package.jsonfaile ir įdėkite šį kodą:

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

Kursime aplanką, vadinamą src, ir tai bus vienintelis aplankas visame mūsų serveryje.

Sukurkite aplanką, vadinamą src, tada aplanko viduje sukursime tik tris failus.

Mūsų srcaplanke sukurkite failą, vadinamą schema.graphql. Į šį pirmąjį failą įdėkite šį kodą:

type Query { hello: String }

Šiame schema.graphqlfaile bus visa mūsų GraphQL schema. Jei nežinai, kas tai, paaiškinsiu vėliau - nesijaudink.

Dabar srcaplanke sukurkite antrą failą. Paskambinkite resolvers.jsir į šį antrąjį failą įdėkite šį kodą:

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

Šis resolvers.jsfailas bus būdas, kuriuo mes pateiksime instrukcijas, kaip paversti GraphQL operaciją duomenimis.

Galiausiai srcaplanke sukurkite trečią failą. Skambinkite tai db.jsir į šį trečiąjį failą įdėkite šį kodą:

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

Kaip matėte, GraphQL yra nauja technologija, kuri yra tikrai galinga. Tai suteikia mums realios galios kurti geresnes ir gerai sukurtas API. Štai kodėl aš rekomenduoju pradėti tai mokytis dabar. Man tai ilgainiui pakeis REST.

Ačiū, kad perskaitėte straipsnį.

Sekite mane „Twitter“!

Sekite mane per „GitHub“!

Aš ieškau nuotolinės galimybės, todėl, jei turėčiau tokių, norėčiau apie tai sužinoti, todėl susisiekite su manimi savo „ Twitter“ !