En nybörjarguide för GraphQL

En av de mest diskuterade termerna idag är API. Många människor vet inte exakt vad ett API är. I grund och botten står API för Application Programming Interface. Det är, som namnet säger, ett gränssnitt som människor - utvecklare, användare, konsumenter - kan interagera med data med.

Du kan tänka på ett API som en bartender. Du ber bartendern om en drink, och de ger dig vad du ville ha. Enkel. Så varför är det ett problem?

Sedan starten på den moderna webben har bygga API: er inte varit så svårt som det låter. Men att lära och förstå API: er var. Utvecklare utgör majoriteten av de människor som kommer att använda ditt API för att bygga något eller bara konsumera data. Så ditt API bör vara så rent och så intuitivt som möjligt. Ett väldesignat API är väldigt enkelt att använda och lära sig. Det är också intuitivt, en bra punkt att tänka på när du börjar utforma ditt API.

Vi har använt REST för att bygga API under lång tid. Tillsammans med det kommer några problem. När du bygger ett API med REST-design kommer du att få problem som:

1) du har många slutpunkter

2) det blir mycket svårare för utvecklare att lära sig och förstå ditt API

3) det finns över- och underhämtning av information

För att lösa dessa problem skapade Facebook GraphQL. Idag tror jag att GraphQL är det bästa sättet att bygga API: er. Denna artikel kommer att berätta varför du bör börja lära dig det idag.

I den här artikeln kommer du att lära dig hur GraphQL fungerar. Jag ska visa dig hur du skapar ett väldesignat, effektivt, kraftfullt API med GraphQL.

Du har förmodligen redan hört talas om GraphQL, eftersom många människor och företag använder det. Sedan GraphQL är öppen källkod har dess community blivit enorm.

Nu är det dags för dig att börja lära dig i praktiken hur GraphQL fungerar och allt om dess magi.

Vad är GraphQL?

GraphQL är ett öppen källkodsspråk utvecklat av Facebook. Det ger oss ett mer effektivt sätt att designa, skapa och konsumera våra API: er. I grund och botten är det ersättningen för REST.

GraphQL har många funktioner, som:

  1. Du skriver de data du vill ha och du får exakt de data du vill ha. Inget mer överhämtning av information som vi är vana vid med REST.
  2. Det ger oss en enda slutpunkt , inte mer version 2 eller version 3 för samma API.
  3. GraphQL är starkt typad , och med det kan du validera en fråga inom GraphQL-typsystemet före körning. Det hjälper oss att bygga mer kraftfulla API: er.

Det här är en grundläggande introduktion till GraphQL - varför den är så kraftfull och varför den blir mycket populär idag. Om du vill lära dig mer om det, rekommenderar jag att du besöker webbplatsen GraphQL och kolla in den.

Komma igång

Huvudmålet i den här artikeln är inte att lära sig att ställa in en GraphQL-server, så vi går inte djupt in i det för tillfället. Målet är att lära sig hur GraphQL fungerar i praktiken, så vi använder en GraphQL-server med nollkonfiguration som heter ☄️ Graphpack.

För att starta vårt projekt ska vi skapa en ny mapp och du kan namnge den vad du vill. Jag ska namnge det graphql-server:

Öppna din terminal och skriv:

mkdir graphql-server

Nu bör du ha npm eller garn installerat i din maskin. Om du inte vet vad det här är, är npm och garn pakethanterare för JavaScript-programmeringsspråket. För Node.js är standardpakethanteraren npm .

Skriv in följande kommando i din skapade mapp:

npm init -y

Eller om du använder garn:

yarn init 

npm skapar en package.jsonfil åt dig, och alla beroenden som du installerade och dina kommandon kommer att finnas där.

Så nu ska vi installera det enda beroendet som vi ska använda.

☄️Graphpack låter dig skapa en GraphQL-server med ingen konfiguration . Eftersom vi just har börjat med GraphQL hjälper det oss mycket att fortsätta och lära oss mer utan att bli oroliga för en serverkonfiguration.

I din terminal, inuti din rotmapp, installera den så här:

npm install --save-dev graphpack

Eller om du använder garn bör du gå så här:

yarn add --dev graphpack

När Graphpack har installerats går du till våra skript i package.jsonfilen och lägger följande kod där:

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

Vi ska skapa en mapp som heter srcoch det kommer att vara den enda mappen på hela vår server.

Skapa en mapp som heter src, efter det, inuti vår mapp, ska vi bara skapa tre filer.

srcSkapa en fil som heter i vår mapp schema.graphql. Inuti den här första filen lägger du till följande kod:

type Query { hello: String }

I den här schema.graphqlfilen kommer att vara hela vårt GraphQL-schema. Om du inte vet vad det är ska jag förklara senare - oroa dig inte.

srcSkapa nu en andra fil inuti vår mapp. Ring det resolvers.jsoch sätt in följande kod i den andra filen:

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

Den här resolvers.jsfilen kommer att vara så som vi tillhandahåller instruktioner för att omvandla en GraphQL-operation till data.

Och slutligen, inuti din srcmapp, skapa en tredje fil. Ring det här db.jsoch lägg in följande kod i den tredje filen:

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!