Como criar uma API GraphQL?

Ei! Como provedor de API, vi em primeira mão como o GraphQL se tornou uma virada de jogo no mundo das APIs. Neste blog, mostrarei como criar uma API GraphQL.

Compreendendo os princípios básicos do GraphQL

Primeiramente, vamos entender o que é GraphQL. Ao contrário do REST, que possui um conjunto fixo de endpoints que retornam estruturas de dados predefinidas, o GraphQL permite que os clientes especifiquem exatamente quais dados precisam. Isso significa menos busca excessiva ou insuficiente de dados, o que é uma grande vantagem.

Imagine que você está criando um aplicativo que precisa de informações do usuário. Com uma API REST, você pode ter um endpoint como/usuários/:idque retorna um monte de dados do usuário, alguns dos quais seu aplicativo pode nem usar. Mas com GraphQL, o cliente pode enviar uma consulta como esta:

consulta {usuário(id: "123") { nome e-mail } }

E só conseguirá onomeee-mailcampos do usuário com o ID123.

Configurando o Ambiente

Para criar uma API GraphQL, você precisará de algumas ferramentas. O mais popular para construir servidores GraphQL é o Apollo Server, que funciona muito bem com Node.js. Então, se ainda não o fez, instale o Node.js em sua máquina.

Depois de instalar o Node.js, crie um novo diretório para o seu projeto e navegue até ele no seu terminal. Em seguida, inicialize um novo projeto Node.js executando:

npm inicialização -y

Isto criará umpacote.jsonarquivo no diretório do seu projeto.

Em seguida, instale o Apollo Server e o GraphQL:

npm instala o apollo-server graphql

Definindo o Esquema

O esquema é o coração de uma API GraphQL. Ele define os tipos de dados que os clientes podem consultar e as relações entre eles.

Digamos que estamos construindo uma API para uma biblioteca simples. Poderíamos ter tipos paraLivro,Autor, eGênero. Veja como você pode definir um esquema básico em JavaScript:

const {gql} = require('apollo-server'); const typeDefs = gql` type Livro { id: ID! título: Corda! autor: Autor! gênero: Gênero! } digite Autor { id: ID! nome: Corda! livros: [Livro!]! } digite Gênero { id: ID! nome: Corda! livros: [Livro!]! } type Query { livros: [Livro!]! livro(id: ID!): Autores do livro: [Autor!]! autor(id: ID!): Gêneros do autor: [Gênero!]! gênero (id: ID!): Gênero } `; module.exportações = typeDefs;

Neste esquema, definimos três tipos (Livro,Autor, eGênero) e umConsultatipo que permite aos clientes buscar dados. O!símbolo significa que um campo é obrigatório.

Resolvedores

Resolvedores são funções que informam ao GraphQL como obter os dados de cada campo do esquema. Por exemplo, o resolvedor para olivroscampo noConsultatype pode buscar uma lista de livros de um banco de dados.

Aqui está um conjunto simples de resolvedores para nossa API de biblioteca:

const {livros, autores, gêneros } = require('./data'); const resolvers = { Consulta: { livros: () => livros, livro: (pai, { id }) => livros.find(livro => livro.id === id), autores: () => autores, autor: (pai, { id }) => autores.find(autor => autor.id === id), gêneros: () => gêneros, gênero: (pai, { id }) => gêneros.find(gênero => gênero.id === id) }, Livro: { autor: (livro) => autores.find(autor => autor.id === livro.autorId), gênero: (livro) => gêneros.find(gênero => gênero.id === livro.genreId) }, Autor: { livros: (autor) => livros.filter(livro => livro.autorId === autor.id) }, Gênero: { livros: (gênero) => livros.filter(livro => livro.genreId === gênero.id) } }; module.exports = resolvedores;

Neste código, assumimos que temos alguns dados de amostra em umdados.jsarquivo. Os resolvedores para oConsultatype retorna os dados apropriados e os resolvedores dos outros tipos tratam dos relacionamentos entre os tipos.

Criando o Servidor

Agora que temos nosso esquema e resolvedores, é hora de criar o Apollo Server.

const {ApolloServer} = require('apollo-server'); const typeDefs = require('./schema'); const resolvedores = require('./resolvers'); servidor const = novo ApolloServer ({ typeDefs, resolvedores }); server.listen().then(({ url }) => { console.log(`Servidor pronto em ${url}`); });

Quando você executa este código comnó index.js(assumindo que seu arquivo tenha o nomeindex.js), o servidor começará a rodar em uma porta local e você poderá acessar o playground GraphQL na URL impressa no console.

Testando a API

Assim que o servidor estiver em execução, você poderá testar sua API usando o playground GraphQL. Abra a URL em seu navegador e você verá uma interface onde poderá escrever consultas e mutações.

Por exemplo, você pode escrever uma consulta para obter todos os livros:

consulta {livros {título autor {nome} } }

Esta consulta retornará uma lista de livros com seus títulos e nomes de seus autores.

Segurança e desempenho

Ao criar uma API GraphQL, segurança e desempenho são cruciais. Você precisa ter certeza de que os clientes só podem acessar os dados que têm permissão para ver. Uma maneira de fazer isso é implementar mecanismos de autenticação e autorização.

Para desempenho, você pode usar técnicas como cache e lote. O Apollo Server possui suporte integrado para cache e você pode usar bibliotecas comocarregador de dadospara solicitações de banco de dados em lote.

Integração com sistemas existentes

Como provedor de API, talvez você precise integrar sua API GraphQL a sistemas existentes, como bancos de dados ou outras APIs. Você pode usar conectores ou adaptadores para interagir com esses sistemas. Por exemplo, se você estiver usando um banco de dados PostgreSQL, poderá usar o comandopág.biblioteca para se conectar a ele e buscar dados.

Conclusão

Criar uma API GraphQL é uma ótima maneira de fornecer acesso de dados flexível e eficiente aos seus clientes. Seguindo as etapas descritas neste blog, você pode construir uma API GraphQL robusta que atenda às necessidades de seus usuários.

Se você estiver interessado em usar nossos serviços de API ou tiver alguma dúvida sobre o desenvolvimento da API GraphQL, sinta-se à vontade para entrar em contato conosco para uma discussão sobre compras. Estamos sempre dispostos a conversar e ajudá-lo a encontrar as melhores soluções para o seu negócio.

Também oferecemos APIs relacionadas a diversos setores. Por exemplo, se você trabalha na indústria farmacêutica, pode estar interessado em APIs relacionadas a produtos comoAnastrozoleGuaifenesina. Você também pode conferir mais sobreAnastrozolem nosso site.

Referências

• Documentação do servidor Apollo
• Especificação GraphQL
• Documentação do Node.js.