Aloittelijan opas GraphQL: ään

Yksi yleisimmin keskustelluista termeistä on nykyään API. Monet ihmiset eivät tiedä tarkalleen mitä API on. Pohjimmiltaan API tarkoittaa Application Programming Interface. Kuten nimessä sanotaan, se on käyttöliittymä, jonka avulla ihmiset - kehittäjät, käyttäjät, kuluttajat - voivat olla vuorovaikutuksessa datan kanssa.

Voit ajatella API: ta baarimestarina. Pyydät baarimesta juomaa, ja he antavat sinulle mitä halusit. Yksinkertainen. Joten miksi se on ongelma?

Nykyaikaisen verkon alusta lähtien sovellusliittymien rakentaminen ei ole ollut niin vaikeaa kuin miltä se kuulostaa. Mutta API: ien oppiminen ja ymmärtäminen oli. Kehittäjät muodostavat suurimman osan ihmisistä, jotka käyttävät sovellusliittymääsi rakentamaan jotain tai vain kuluttamaan tietoja. Joten sovellusliittymän tulee olla mahdollisimman puhdas ja intuitiivinen. Hyvin suunniteltu API on erittäin helppo käyttää ja oppia. Se on myös intuitiivinen, hyvä asia pitää mielessä, kun aloitat sovellusliittymän suunnittelua.

Olemme käyttäneet REST: ää API: n rakentamiseen pitkään. Sen mukana tulee joitain ongelmia. Kun rakennat sovellusliittymää REST-suunnittelun avulla, kohtaat joitain ongelmia, kuten:

1) sinulla on paljon päätepisteitä

2) kehittäjien on paljon vaikeampaa oppia ja ymmärtää sovellusliittymäsi

3) tietoa on liikaa ja liian vähän

Näiden ongelmien ratkaisemiseksi Facebook loi GraphQL: n. Tänään mielestäni GraphQL on paras tapa rakentaa sovellusliittymiä. Tässä artikkelissa kerrotaan, miksi sinun pitäisi alkaa oppia sitä jo tänään.

Tässä artikkelissa opit, kuinka GraphQL toimii. Näytän sinulle, kuinka luoda erittäin hyvin suunniteltu, tehokas ja tehokas sovellusliittymä GraphQL: n avulla.

Olet luultavasti jo kuullut GraphQL: stä, koska monet ihmiset ja yritykset käyttävät sitä. Koska GraphQL on avoimen lähdekoodin, sen yhteisö on kasvanut valtavasti.

Nyt on aika alkaa oppia käytännössä, kuinka GraphQL toimii ja kaikki sen taikuudesta.

Mikä on GraphQL?

GraphQL on avoimen lähdekoodin kyselykieli, jonka on kehittänyt Facebook. Se tarjoaa meille tehokkaamman tavan suunnitella, luoda ja kuluttaa sovellusliittymiä. Pohjimmiltaan se korvaa RESTin.

GraphQL: llä on paljon ominaisuuksia, kuten:

  1. Kirjoitat haluamasi tiedot ja saat juuri haluamasi tiedot. Ei enää tiedonhankintaa, kuten olemme tottuneet REST: n kanssa.
  2. Se antaa meille yhden päätepisteen , ei enää versiota 2 tai versiota 3 samalle sovellusliittymälle.
  3. GraphQL on vahvasti kirjoitettu , ja sen avulla voit vahvistaa kyselyn GraphQL-tyyppisessä järjestelmässä ennen suoritusta. Se auttaa meitä rakentamaan tehokkaampia sovellusliittymiä.

Tämä on GraphQL: n perustiedot - miksi se on niin tehokas ja miksi se saa paljon suosiota näinä päivinä. Jos haluat oppia lisää siitä, suosittelen sinua siirtymään GraphQL-verkkosivustolle ja tarkistamaan sen.

Päästä alkuun

Tämän artikkelin päätavoitteena ei ole oppia luomaan GraphQL-palvelinta, joten emme ole vielä syventymässä siihen. Tavoitteena on oppia, kuinka GraphQL toimii käytännössä, joten aiomme käyttää nollakokoonpanon GraphQL-palvelinta nimeltä ☄️ Graphpack.

Aloitamme projektimme luomalla uuden kansion ja voit nimetä sen mitä haluat. Aion nimetä sen graphql-server:

Avaa pääte ja kirjoita:

mkdir graphql-server

Nyt koneellesi tulisi olla asennettu npm tai lanka . Jos et tiedä mitä nämä ovat, npm ja lanka ovat paketinhallintaohjelmia JavaScript-ohjelmointikielelle. Node.js: n oletuspaketinhallinta on npm .

Kirjoita luomaasi kansioon seuraava komento:

npm init -y

Tai jos käytät lankaa:

yarn init 

npm luo package.jsontiedoston sinulle, ja kaikki asentamasi riippuvuudet ja komennot ovat siellä.

Joten nyt aiomme asentaa ainoan riippuvuuden , jota aiomme käyttää.

☄️Graphpackin avulla voit luoda GraphQL-palvelimen, jolla ei ole asetuksia . Koska olemme vasta aloittamassa GraphQL: n kanssa, se auttaa meitä paljon jatkamaan ja oppimaan lisää huolimatta palvelimen kokoonpanosta.

Asenna päätelaitteessasi juurikansiosi seuraavasti:

npm install --save-dev graphpack

Tai jos käytät lankaa, sinun tulee toimia näin:

yarn add --dev graphpack

Kun Graphpack on asennettu, siirry komentosarjamme package.jsontiedostoon ja laita seuraava koodi sinne:

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

Aiomme luoda kansion nimeltä src, ja se tulee olemaan ainoa kansio koko palvelimessamme.

Luo kansio nimeltä src, jonka jälkeen luomme kansion sisällä vain kolme tiedostoa.

srcLuo kansion sisällä tiedosto nimeltä schema.graphql. Laita tämän ensimmäisen tiedoston sisään seuraava koodi:

type Query { hello: String }

Tässä schema.graphqltiedostossa tulee olemaan koko GraphQL-skeema. Jos et tiedä mikä se on, selitän myöhemmin - älä huoli.

srcLuo nyt kansiossamme toinen tiedosto. Soita sille resolvers.jsja lisää tämän toisen tiedoston sisään seuraava koodi:

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

Tämä resolvers.jstiedosto tulee olemaan tapa, jolla annamme ohjeet GraphQL-toiminnon muuttamiseksi dataksi.

Ja lopuksi, srcluo kansiossasi kolmas tiedosto. Kutsu tätä db.jsja kirjoita tämän kolmannen tiedoston sisään seuraava koodi:

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

Kuten olet nähnyt, GraphQL on uusi tekniikka, joka on todella tehokas. Se antaa meille todellista voimaa rakentaa parempia ja hyvin suunniteltuja sovellusliittymiä. Siksi suosittelen, että aloitat sen oppimisen nyt. Minulle se lopulta korvaa RESTin.

Kiitos artikkelin lukemisesta.

Seuraa minua Twitterissä!

Seuraa minua GitHubissa!

Etsin etämahdollisuutta, joten jos minulla on sellaisia, haluaisin kuulla siitä, joten ota yhteyttä minuun Twitterissä !