Kezdő útmutató a GraphQL-hez

Az egyik leggyakrabban megvitatott kifejezés az API. Sokan nem tudják pontosan, mi az API. Alapvetően az API az Application Programming Interface rövidítést jelenti . Ez, amint a neve mondja, olyan felület, amelyen az emberek - fejlesztők, felhasználók, fogyasztók - kölcsönhatásba léphetnek az adatokkal.

Gondolhat egy API-ra, mint egy csaposra. Kérsz ​​egy italt a csapostól, és ők megadják neked, amit akartál. Egyszerű. Tehát miért ez a probléma?

A modern web kezdete óta az API-k építése nem volt olyan nehéz, mint amilyennek hangzik. De az API-k megtanulása és megértése volt. A fejlesztők alkotják az emberek többségét, akik az API-ját felhasználják valamilyen építéshez, vagy csak adatfogyasztáshoz. Tehát az API-nak a lehető legtisztábbnak és intuitívabbnak kell lennie. Egy jól megtervezett API nagyon könnyen használható és megtanulható. Ez egyúttal intuitív is, jó szempont, amelyet szem előtt kell tartani, amikor elkezdi tervezni az API-t.

Régóta használjuk a REST-et API-k készítéséhez. Ezzel együtt jön néhány probléma. Ha egy API-t REST tervezéssel készít, akkor néhány problémával kell szembenéznie:

1) sok végpontod lesz

2) A fejlesztők számára sokkal nehezebb lesz megtanulni és megérteni az API-t

3) túl sok és túl kevés az információ

E problémák megoldására a Facebook létrehozta a GraphQL-t. Ma úgy gondolom, hogy a GraphQL a legjobb módszer az API-k felépítésére. Ez a cikk megmondja, miért kell elkezdenie ma megtanulni.

Ebben a cikkben megtudhatja, hogyan működik a GraphQL. Megmutatom, hogyan hozhat létre egy nagyon jól megtervezett, hatékony, hatékony API-t a GraphQL segítségével.

Valószínűleg már hallott a GraphQL-ről, mivel sok ember és vállalat használja. Amióta a GraphQL nyílt forráskódú, a közösség hatalmasra nőtt.

Itt az ideje, hogy elkezdje a gyakorlatban megtanulni a GraphQL működését és annak varázslatát.

Mi a GraphQL?

A GraphQL egy nyílt forráskódú lekérdezési nyelv, amelyet a Facebook fejlesztett ki. Ez hatékonyabb módon biztosítja számunkra az API-k tervezését, létrehozását és felhasználását. Alapvetően ez a REST helyettesítője.

A GraphQL sok funkcióval rendelkezik, például:

  1. Ön megírja a kívánt adatokat, és pontosan megkapja a kívánt adatokat. Nincs több információhívás, mint azt a REST-hez szoktuk.
  2. Ez egyetlen végpontot ad nekünk , nem több 2. vagy 3. verzió ugyanarra az API-ra.
  3. A GraphQL erőteljesen be van írva , és ezzel ellenőrizheti a lekérdezést a GraphQL típusú rendszerben a végrehajtás előtt. Ez segít nekünk hatékonyabb API-k kiépítésében.

Ez egy alapvető bevezetés a GraphQL-hez - miért olyan erős, és miért kap nagy népszerűséget manapság. Ha többet szeretne megtudni róla, javasoljuk, hogy keresse fel a GraphQL webhelyet, és nézze meg.

Elkezdeni

A cikk fő célja nem egy GraphQL szerver telepítésének megtanulása, ezért egyelőre nem foglalkozunk ezzel a mélységgel. A cél annak megismerése, hogy a GraphQL hogyan működik a gyakorlatban, ezért egy nulla konfigurációjú GraphQL szervert fogunk használni ☄️ Graphpack néven.

A projektünk megkezdéséhez létrehozunk egy új mappát, és megnevezheti, amit csak akar. Meg fogom nevezni graphql-server:

Nyissa meg a terminált, és írja be:

mkdir graphql-server

Most telepítenie kell a gépére az npm-et vagy a fonalat . Ha nem tudja mik ezek, akkor az npm és a fonal csomagkezelők a JavaScript programozási nyelv számára. A Node.js esetében az alapértelmezett csomagkezelő az npm .

A létrehozott mappába írja be a következő parancsot:

npm init -y

Vagy ha fonalat használ:

yarn init 

Az npm létrehoz egy package.jsonfájlt az Ön számára, és minden telepített függőség és a parancsok ott lesznek.

Tehát most telepítjük az egyetlen függőséget , amelyet használni fogunk.

A aph️Graphpack segítségével nulla konfigurációjú GraphQL szervert hozhat létre . Mivel most kezdünk a GraphQL-tel, ez sokat segít nekünk a továbbjutásban és a további információk megismerésében anélkül, hogy aggódnánk a szerver konfigurációja miatt.

A terminálban, a gyökérmappában, telepítse a következőképpen:

npm install --save-dev graphpack

Vagy ha fonalat használ, akkor a következőket kell tennie:

yarn add --dev graphpack

A Graphpack telepítése után lépjen a szkriptek package.jsonfájlba, és tegye oda a következő kódot:

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

Létrehozunk egy nevű mappát src, és ez lesz az egyetlen mappa a teljes szerverünkön.

Hozzon létre egy nevű srcmappát, majd a mappánkban csak három fájlt fogunk létrehozni.

A srcmappánkban hozzon létre egy nevű fájlt schema.graphql. Az első fájlba írja be a következő kódot:

type Query { hello: String }

Ebben a schema.graphqlfájlban a teljes GraphQL sémánk lesz. Ha nem tudod, mi az, később elmagyarázom - ne aggódj.

Most a srcmappánkban hozzon létre egy második fájlt. Hívja, resolvers.jsés ebbe a második fájlba írja be a következő kódot:

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

Ez a resolvers.jsfájl lesz az a mód, ahogyan megadjuk az utasításokat a GraphQL művelet adatokká alakításához.

Végül srchozzon létre egy harmadik fájlt a mappájában. Hívja ezt, db.jsés a harmadik fájlba írja be a következő kódot:

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!