Przewodnik dla początkujących po GraphQL

Jednym z najczęściej omawianych obecnie terminów jest API. Wiele osób nie wie dokładnie, czym jest API. Zasadniczo API oznacza interfejs programowania aplikacji. Jak sama nazwa wskazuje, jest to interfejs, za pomocą którego ludzie - programiści, użytkownicy, konsumenci - mogą wchodzić w interakcje z danymi.

Możesz myśleć o API jak o barmanie. Poproś barmana o drinka, a on da ci to, czego chciałeś. Prosty. Więc dlaczego to jest problem?

Od początku istnienia nowoczesnej sieci tworzenie interfejsów API nie było tak trudne, jak się wydaje. Ale nauka i zrozumienie API było. Deweloperzy to większość ludzi, którzy będą używać Twojego interfejsu API do tworzenia czegoś lub po prostu konsumowania danych. Dlatego twoje API powinno być tak czyste i intuicyjne, jak to tylko możliwe. Dobrze zaprojektowany interfejs API jest bardzo łatwy w użyciu i nauce. Jest również intuicyjny, o czym warto pamiętać, rozpoczynając projektowanie interfejsu API.

Od dłuższego czasu używamy REST do tworzenia interfejsów API. Wraz z tym pojawiają się pewne problemy. Podczas budowania API przy użyciu projektu REST napotkasz kilka problemów, takich jak:

1) będziesz mieć wiele punktów końcowych

2) programistom będzie znacznie trudniej nauczyć się i zrozumieć Twój interfejs API

3) występuje nadmierne lub niedostateczne pobieranie informacji

Aby rozwiązać te problemy, Facebook stworzył GraphQL. Obecnie uważam, że GraphQL to najlepszy sposób na tworzenie interfejsów API. W tym artykule dowiesz się, dlaczego warto zacząć się tego uczyć już dziś.

W tym artykule dowiesz się, jak działa GraphQL. Pokażę ci, jak stworzyć bardzo dobrze zaprojektowane, wydajne i wydajne API przy użyciu GraphQL.

Prawdopodobnie słyszałeś już o GraphQL, ponieważ korzysta z niego wiele osób i firm. Odkąd GraphQL jest oprogramowaniem typu open source, jego społeczność rozrosła się.

Teraz nadszedł czas, abyś zaczął uczyć się w praktyce, jak działa GraphQL i wszystko o jego magii.

Co to jest GraphQL?

GraphQL to język zapytań typu open source opracowany przez Facebook. Zapewnia nam bardziej wydajny sposób projektowania, tworzenia i korzystania z naszych interfejsów API. Zasadniczo jest to zamiennik REST.

GraphQL ma wiele funkcji, takich jak:

  1. Piszesz potrzebne dane i otrzymujesz dokładnie takie dane, jakie chcesz. Koniec z nadmiernym pobieraniem informacji, do czego przywykliśmy z REST.
  2. Daje nam jeden punkt końcowy , nie więcej wersji 2 ani wersji 3 dla tego samego interfejsu API.
  3. GraphQL jest silnie wpisany i dzięki temu możesz zweryfikować zapytanie w systemie typów GraphQL przed wykonaniem. Pomaga nam budować potężniejsze interfejsy API.

To jest podstawowe wprowadzenie do GraphQL - dlaczego jest tak potężny i dlaczego zyskuje ostatnio dużą popularność. Jeśli chcesz dowiedzieć się więcej na ten temat, polecam wejść na stronę GraphQL i to sprawdzić.

Pierwsze kroki

Głównym celem tego artykułu nie jest nauczenie się, jak skonfigurować serwer GraphQL, więc na razie nie zagłębiamy się w to. Celem jest nauczenie się, jak GraphQL działa w praktyce, więc użyjemy zerowego serwera GraphQL o nazwie ☄️ Graphpack.

Aby rozpocząć nasz projekt, utworzymy nowy folder i możesz nadać mu dowolną nazwę. Nazwę to graphql-server:

Otwórz terminal i wpisz:

mkdir graphql-server

Teraz powinieneś mieć zainstalowany npm lub przędzę w swojej maszynie. Jeśli nie wiesz, co to jest, npm i yarn są menedżerami pakietów dla języka programowania JavaScript. W przypadku Node.js domyślnym menedżerem pakietów jest npm .

Wewnątrz utworzonego folderu wpisz następujące polecenie:

npm init -y

Lub jeśli używasz przędzy:

yarn init 

npm utworzy package.jsondla ciebie plik, a wszystkie zależności, które zainstalowałeś, i twoje polecenia będą tam.

Więc teraz zainstalujemy jedyną zależność , której będziemy używać.

☄️Graphpack umożliwia utworzenie serwera GraphQL bez konfiguracji . Ponieważ dopiero zaczynamy od GraphQL, bardzo nam to pomoże w kontynuowaniu i nauce więcej bez martwienia się o konfigurację serwera.

W swoim terminalu, w folderze głównym, zainstaluj go w następujący sposób:

npm install --save-dev graphpack

Lub, jeśli używasz przędzy, powinieneś postępować w ten sposób:

yarn add --dev graphpack

Po zainstalowaniu Graphpack przejdź do naszych skryptów w package.jsonpliku i umieść tam następujący kod:

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

Utworzymy folder o nazwie srci będzie to jedyny folder na całym naszym serwerze.

Utwórz folder o nazwie src, a następnie w naszym folderze utworzymy tylko trzy pliki.

W naszym srcfolderze utwórz plik o nazwie schema.graphql. Wewnątrz tego pierwszego pliku umieść następujący kod:

type Query { hello: String }

W tym schema.graphqlpliku będzie cały nasz schemat GraphQL. Jeśli nie wiesz, co to jest, wyjaśnię później - nie martw się.

Teraz w naszym srcfolderze utwórz drugi plik. Wywołaj go resolvers.jsi wewnątrz tego drugiego pliku umieść następujący kod:

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

Ten resolvers.jsplik będzie sposobem, w jaki udostępniamy instrukcje przekształcania operacji GraphQL na dane.

Na koniec srcutwórz trzeci plik w folderze. Wywołaj to db.jsi wewnątrz tego trzeciego pliku umieść następujący 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

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!