Как создать API-сервер GraphQL с помощью Express JS в Node JS

В этом руководстве вы создадите сервер Express API в Node.js , который обслуживает конечную точку GraphQL. Вы также создадите схему GraphQL на основе системы типов GraphQL, включая такие операции, как запросы и мутации, и функции разрешения для генерации ответов на любые запросы.

Настройка экспресс-сервера HTTP

Первый шаг — настроить сервер Express, что вы можете сделать до написания кода GraphQL.

В новом проекте вы установите expressи corsс помощью npm installкоманды:

npm install express cors

Express будет основой для вашего сервера. Это платформа веб-приложений для Node.js, предназначенная для создания API. Пакет CORS , представляющий собой промежуточное ПО для совместного использования ресурсов Cross- Origin, позволит вам легко получить доступ к этому серверу из браузера.

Вы также можете установить Nodemon как зависимость от разработчиков:

npm install -D nodemon

Nodemon — это инструмент, который помогает разрабатывать приложения на основе Node, автоматически перезапуская приложение при обнаружении изменений файлов в каталоге.

При установке этих пакетов будут созданы две зависимости node_modulesи package.jsonодна зависимость от разработчиков.

С помощью nanoили вашего любимого текстового редактора откройте package.jsonдля редактирования, что будет выглядеть примерно так:

{
  "dependencies": {
    "cors": "^2.8.5",
    "express": "^4.17.3"
  },
  "devDependencies": {
    "nodemon": "^2.0.15"
  }
}

На этом этапе вы добавите еще несколько полей. Внесите package.jsonследующие выделенные изменения:

{
  "main": "server.js",
  "scripts": {
    "dev": "nodemon server.js"
  },
  "dependencies": {
    "cors": "^2.8.5",
    "express": "^4.17.3"
  },
  "devDependencies": {
    "nodemon": "^2.0.15"
  },
  "type": "module"
}

Вы будете создавать файл для сервера по адресу server.js, поэтому mainукажите на server.js. Это обеспечит npm startзапуск сервера.

Чтобы упростить разработку на сервере, вы также создаете скрипт с именем "dev", который будет запускать файлы nodemon server.js.

Наконец, вы добавляете typeof module, чтобы убедиться, что вы можете использовать importоператоры во всем коде вместо использования CommonJS по умолчанию require.

Сохраните и закройте файл, когда закончите.

Далее создайте файл с именем server.js. В нем вы создадите простой сервер Express, прослушаете порт 4000и отправите запрос со словами Hello, GraphQL!. Чтобы настроить это, добавьте следующие строки в новый файл:

import express from 'express'
import cors from 'cors'

const app = express()
const port = 4000

app.use(cors())
app.use(express.json())
app.use(express.urlencoded({ extended: true }))

app.get('/', (request, response) => {
  response.send('Hello, GraphQL!')
})

app.listen(port, () => {
  console.log(`Running a server at http://localhost:${port}`)
})

Этот блок кода создает базовый HTTP-сервер с Express. Вызывая expressфункцию, вы создаете экспресс-приложение. После настройки нескольких основных параметров для CORS и JSON вы определите, что должно быть отправлено с GETзапросом в корень ( /) с использованием app.get('/'). Наконец, используйте app.listen()для определения порта, который должен прослушивать сервер API.

Сохраните и закройте файл, когда закончите.

Теперь вы можете запустить команду для запуска сервера Node:

npm run dev

Если вы зайдете http://localhost:4000в браузере или запустите curl http://localhost:4000команду, вы увидите, что она возвращает Hello, GraphQL!значение, указывающее, что сервер Express запущен. На этом этапе вы можете начать добавлять код для обслуживания конечной точки GraphQL.

Настройка ПО промежуточного слоя HTTP-сервера GraphQL

В этом разделе вы начнете интегрировать схему GraphQL в базовый сервер Express. Вы сделаете это, определив схему, преобразователи и подключившись к хранилищу данных.

Чтобы начать интеграцию GraphQL в сервер Express, вы установите три пакета: graphql, express-graphqlи @graphql-tools/schema. Выполните следующую команду:

npm install graphql@14 express-graphql @graphql-tools/schema
  • graphql: эталонная реализация JavaScript для GraphQL.
  • express-graphql: ПО промежуточного слоя HTTP-сервера для GraphQL.
  • @graphql-tools/schema: набор утилит для более быстрой разработки GraphQL.

Вы можете импортировать эти пакеты в server.jsфайл, добавив выделенные строки:

import express from 'express'
import cors from 'cors'
import { graphqlHTTP } from 'express-graphql'
import { makeExecutableSchema } from '@graphql-tools/schema'

...

Следующим шагом является создание исполняемой схемы GraphQL.

Чтобы избежать накладных расходов на настройку базы данных, вы можете использовать хранилище в памяти для данных, которые будет запрашивать сервер GraphQL. Вы можете создать dataобъект со значениями, которые будет иметь ваша база данных. Добавьте выделенные строки в ваш файл:

import express from 'express'
import cors from 'cors'
import { graphqlHTTP } from 'express-graphql'
import { makeExecutableSchema } from '@graphql-tools/schema'

const data = {
  warriors: [
    { id: '001', name: 'Jaime' },
    { id: '002', name: 'Jorah' },
  ],
}

...

Структура данных здесь представляет собой таблицу базы данных warriors, которая имеет две строки, представленные записями Jaimeи .Jorah

Теперь, когда ваши пакеты установлены и есть некоторые данные, вы создадите схему, которая определяет API, описывая данные, доступные для запроса.

Схема GraphQL

Теперь, когда у вас есть некоторые базовые данные, вы можете приступить к созданию элементарной схемы для API, чтобы получить минимальный объем кода, необходимый для начала использования конечной точки GraphQL. Эта схема предназначена для воспроизведения чего-то, что можно было бы использовать для фэнтезийной ролевой игры, в которой есть персонажи, выполняющие такие роли, как воины, волшебники и целители. Этот пример должен быть открытым, чтобы вы могли добавлять столько, сколько хотите, например, заклинания и оружие.

Схема GraphQL основана на системе типов . Есть несколько встроенных типов, а также можно создать свой собственный тип. В этом примере вы создадите новый объект с typeименем Warriorи назначите ему два поля: idи name.

type Warrior {
  id: ID!
  name: String!
}

У idобъекта есть IDтип, и у nameобъекта есть Stringтип. Это встроенные скаляры или примитивные типы. Восклицательный знак ( !) означает, что поле не может принимать значения NULL , и для любого экземпляра этого типа потребуется значение.

Единственная дополнительная информация, необходимая для начала работы, — это базовый Queryтип, который является точкой входа в запрос GraphQL. Мы определим warriorsкак массив Warriorтипов.

type Query {
  warriors: [Warrior]
}

С этими двумя типами у вас есть допустимая схема, которую можно использовать в промежуточном программном обеспечении HTTP GraphQL. В конечном счете, схема, которую вы определяете здесь, будет передана в makeExecutableSchemaфункцию, предоставляемую graphql-toolsas typeDefs. Два свойства, передаваемые в объект makeExecutableSchemaфункции, будут следующими:

  • typeDefs: строка языка схемы GraphQL.
  • resolvers: функции, которые вызываются для выполнения поля и создания значения.

В server.js, после импорта зависимостей создайте typeDefsпеременную и назначьте схему GraphQL в виде строки, как показано здесь:

...

const data = {
  warriors: [
    { id: '001', name: 'Jaime' },
    { id: '002', name: 'Jorah' },
  ],
}

const typeDefs = `
type Warrior {
  id: ID!
  name: String!
}

type Query {
  warriors: [Warrior]
}
`

...

Теперь у вас есть набор данных, а также ваша схема, определенная как dataи typeDefsсоответственно. Далее вы создадите распознаватели, чтобы API знал, что делать с входящими запросами.

Функции преобразователя GraphQL

Резолверы — это набор функций, которые генерируют ответ для сервера GraphQL. Каждая функция резольвера имеет четыре параметра:

  • obj: родительский объект, который здесь использовать не обязательно, так как он уже является корневым или объектом верхнего уровня.
  • args: любые аргументы GraphQL, переданные в поле.
  • context: состояние, совместно используемое всеми преобразователями, часто соединение с базой данных.
  • info: Дополнительная информация .

В этом случае вы создадите преобразователь для корневого Queryтипа и вернете значение для warriors.

Чтобы начать работу с этим примером сервера, передайте хранилище данных в памяти из ранее в этом разделе, добавив выделенные строки в server.js:

...

const typeDefs = `
type Warrior {
  id: ID!
  name: String!
}

type Query {
  warriors: [Warrior]
}
`

const resolvers = {
  Query: {
    warriors: (obj, args, context, info) => context.warriors,
  },
}

...

Точка входа на сервер GraphQL будет через корневой Queryтип на преобразователях. Теперь вы добавили одну функцию разрешения, называемую warriors, которая будет возвращать значение warriorsиз context. contextэто место, где будет находиться ваша точка входа в базу данных, и для этой конкретной реализации это будет dataпеременная, содержащая ваше хранилище данных в памяти.

Каждая отдельная функция преобразователя имеет четыре параметра: obj, args, contextи info. Самый полезный и актуальный параметр для нашей схемы прямо сейчас — contextэто объект, совместно используемый распознавателями. Он часто используется в качестве соединения между сервером GraphQL и базой данных.

Наконец, когда typeDefsвсе resolversустановлено, у вас достаточно информации для создания исполняемой схемы. Добавьте выделенные строки в ваш файл:

...

const resolvers = {
  Query: {
    warriors: (obj, args, context, info) => context.warriors,
  },
}

const executableSchema = makeExecutableSchema({
  typeDefs,
  resolvers,
})

...

Функция makeExecutableSchema создает полную схему, которую вы можете передать в конечную точку GraphQL.

Теперь замените корневую конечную точку по умолчанию, которая в настоящее время возвращается Hello, GraphQL!, на следующую /graphqlконечную точку, добавив выделенные строки:

...

const executableSchema = makeExecutableSchema({
  typeDefs,
  resolvers,
})

app.use(
  '/graphql',
  graphqlHTTP({
    schema: executableSchema,
    context: data,
    graphiql: true,
  })
)

...

Соглашение заключается в том, что сервер GraphQL будет использовать /graphqlконечную точку. Использование graphqlHTTPпромежуточного программного обеспечения требует передачи схемы и контекста, которым в данном случае является ваше фиктивное хранилище данных.

Теперь у вас есть все необходимое для начала обслуживания конечной точки. Ваш server.jsкод должен выглядеть так:

import express from 'express'
import cors from 'cors'
import { graphqlHTTP } from 'express-graphql'
import { makeExecutableSchema } from '@graphql-tools/schema'

const app = express()
const port = 4000

// In-memory data store
const data = {
  warriors: [
    { id: '001', name: 'Jaime' },
    { id: '002', name: 'Jorah' },
  ],
}

// Schema
const typeDefs = `
type Warrior {
  id: ID!
  name: String!
}

type Query {
  warriors: [Warrior]
}
`

// Resolver for warriors
const resolvers = {
  Query: {
    warriors: (obj, args, context) => context.warriors,
  },
}

const executableSchema = makeExecutableSchema({
  typeDefs,
  resolvers,
})

app.use(cors())
app.use(express.json())
app.use(express.urlencoded({ extended: true }))

// Entrypoint
app.use(
  '/graphql',
  graphqlHTTP({
    schema: executableSchema,
    context: data,
    graphiql: true,
  })
)

app.listen(port, () => {
  console.log(`Running a server at http://localhost:${port}`)
})

Сохраните и закройте файл, когда закончите.

Теперь вы сможете перейти к http://localhost:4000/graphqlсвоей схеме и изучить ее с помощью GraphiQL IDE .

Теперь ваш API GraphQL завершен на основе схемы и распознавателей, созданных в этом разделе. В следующем разделе вы будете использовать интегрированную среду разработки GraphiQL для отладки и понимания вашей схемы.

Использование интегрированной среды разработки GraphiQL

Поскольку вы применили graphiqlопцию trueпромежуточного программного обеспечения GraphQL, у вас есть доступ к интегрированной среде разработки (IDE) GraphiQL. Если вы посетили конечную точку GraphQL в окне браузера, вы окажетесь в GraphiQL.

GraphiQL — это встроенный в браузер инструмент для написания, проверки и тестирования запросов GraphQL. Теперь вы можете протестировать свой сервер GraphQL, чтобы убедиться, что он возвращает правильные данные.

Сделайте запрос для warriors, запросив свойства idи . nameВ браузере добавьте следующие строки в левую панель GraphiQL:

{
  warriors {
    id
    name
  }
}

Отправьте запрос, нажав стрелку воспроизведения в левом верхнем углу, и вы должны увидеть возвращаемое значение в формате JSON справа:

Output{
  "data": {
    "warriors": [
      { "id": "001", "name": "Jaime" },
      { "id": "002", "name": "Jorah" }
    ]
  }
}

Если вы удалите одно из полей в запросе, вы увидите соответствующее изменение возвращаемого значения. Например, если вы хотите получить только nameполе, вы можете написать запрос следующим образом:

{
  warriors {
    name
  }
}

И теперь ваш ответ будет выглядеть так:

Output{
  "data": {
    "warriors": [{ "name": "Jaime" }, { "name": "Jorah" }]
  }
}

Возможность запрашивать только те поля, которые вам нужны, является одним из мощных аспектов GraphQL и делает его языком , управляемым клиентом .

Вернувшись в GraphiQL, если вы нажмете « Документы » до упора вправо, откроется боковая панель с надписью Documentation Explorer . На этой боковой панели вы можете щелкнуть документацию, чтобы просмотреть схему более подробно.

Теперь ваш API готов, и вы узнали, как использовать его из GraphiQL. Следующим шагом будет выполнение реальных запросов от клиента к вашему GraphQL API.

Запрос API GraphQL от клиента

Как и в случае с REST API , клиент может взаимодействовать с GraphQL API, отправляя HTTP-запросы по сети. Поскольку вы можете использовать встроенные API-интерфейсы браузера, например fetch, для выполнения сетевых запросов, вы также можете использовать fetchдля запросов GraphQL.

Для очень простого примера создайте скелет HTML в index.htmlфайле с <pre>тегом:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>GraphQL Client</title>
  </head>

  <pre><!-- data will be displayed here --></pre>

  <body>
    <script>
      // Add query here
    </script>
  </body>
</html>

В scriptтеге сделайте асинхронную функцию, которая отправляет POSTзапрос к GraphQL API:

...
<body>
    <script>
      async function queryGraphQLServer() {
        const response = await fetch('http://localhost:4000/graphql', {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
          },
          body: JSON.stringify({
            query: '{ warriors { name } }',
          }),
        })
        const data = await response.json()
				
        // Append data to the pre tag
        const pre = document.querySelector('pre')
        pre.textContent = JSON.stringify(data, null, 2) // Pretty-print the JSON
      }

      queryGraphQLServer()
    </script>
  </body>
...

Заголовок Content-Typeдолжен иметь значение application/json, а запрос должен быть передан в теле в виде строки. Скрипт вызовет функцию, чтобы сделать запрос, и установит ответ в preтеге.

Вот полный index.htmlкод.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>GraphQL</title>
  </head>

  <pre></pre>

  <body>
    <script>
      async function queryGraphQLServer() {
        const response = await fetch('http://localhost:4000/graphql', {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
          },
          body: JSON.stringify({
            query: '{ warriors { name } }',
          }),
        })
        const data = await response.json()

        const pre = document.querySelector('pre')
        pre.textContent = JSON.stringify(data, null, 2) // Pretty-print the JSON
      }

      queryGraphQLServer()
    </script>
  </body>
</html>

Сохраните и закройте файл, когда закончите.

Теперь, когда вы просматриваете index.htmlфайл в браузере, вы увидите исходящий сетевой запрос к http://localhost:4000/graphqlконечной точке, который вернет a 200с данными. Вы можете просмотреть этот сетевой запрос, открыв Инструменты разработчика и перейдя на вкладку Сеть .

Если ваш запрос прошел и вы получили 200ответ с данными от GraphQL API, поздравляем! Вы создали свой первый API-сервер GraphQL.

Вывод

В этом руководстве вы создали сервер GraphQL API, используя платформу Express в Node.js. Сервер GraphQL состоит из одной /graphqlконечной точки, которая может обрабатывать входящие запросы для запроса хранилища данных. В вашем API была схема с базовым Queryтипом, настраиваемым Warriorтипом и преобразователем для получения правильных данных для этих типов.

Надеемся, что эта статья помогла демистифицировать GraphQL и открыла новые идеи и возможности того, чего можно достичь с помощью GraphQL. Существует множество инструментов, которые могут помочь с более сложными аспектами работы с GraphQL, такими как аутентификация, безопасность и кэширование, но изучение того, как настроить сервер API самым простым способом, должно помочь вам понять основы GraphQL.

Оригинальный источник статьи на https://www.digitalocean.com

#graphql #api #express #expressjs #node #nodejs 

What is GEEK

Buddha Community

Как создать API-сервер GraphQL с помощью Express JS в Node JS

Как создать API-сервер GraphQL с помощью Express JS в Node JS

В этом руководстве вы создадите сервер Express API в Node.js , который обслуживает конечную точку GraphQL. Вы также создадите схему GraphQL на основе системы типов GraphQL, включая такие операции, как запросы и мутации, и функции разрешения для генерации ответов на любые запросы.

Настройка экспресс-сервера HTTP

Первый шаг — настроить сервер Express, что вы можете сделать до написания кода GraphQL.

В новом проекте вы установите expressи corsс помощью npm installкоманды:

npm install express cors

Express будет основой для вашего сервера. Это платформа веб-приложений для Node.js, предназначенная для создания API. Пакет CORS , представляющий собой промежуточное ПО для совместного использования ресурсов Cross- Origin, позволит вам легко получить доступ к этому серверу из браузера.

Вы также можете установить Nodemon как зависимость от разработчиков:

npm install -D nodemon

Nodemon — это инструмент, который помогает разрабатывать приложения на основе Node, автоматически перезапуская приложение при обнаружении изменений файлов в каталоге.

При установке этих пакетов будут созданы две зависимости node_modulesи package.jsonодна зависимость от разработчиков.

С помощью nanoили вашего любимого текстового редактора откройте package.jsonдля редактирования, что будет выглядеть примерно так:

{
  "dependencies": {
    "cors": "^2.8.5",
    "express": "^4.17.3"
  },
  "devDependencies": {
    "nodemon": "^2.0.15"
  }
}

На этом этапе вы добавите еще несколько полей. Внесите package.jsonследующие выделенные изменения:

{
  "main": "server.js",
  "scripts": {
    "dev": "nodemon server.js"
  },
  "dependencies": {
    "cors": "^2.8.5",
    "express": "^4.17.3"
  },
  "devDependencies": {
    "nodemon": "^2.0.15"
  },
  "type": "module"
}

Вы будете создавать файл для сервера по адресу server.js, поэтому mainукажите на server.js. Это обеспечит npm startзапуск сервера.

Чтобы упростить разработку на сервере, вы также создаете скрипт с именем "dev", который будет запускать файлы nodemon server.js.

Наконец, вы добавляете typeof module, чтобы убедиться, что вы можете использовать importоператоры во всем коде вместо использования CommonJS по умолчанию require.

Сохраните и закройте файл, когда закончите.

Далее создайте файл с именем server.js. В нем вы создадите простой сервер Express, прослушаете порт 4000и отправите запрос со словами Hello, GraphQL!. Чтобы настроить это, добавьте следующие строки в новый файл:

import express from 'express'
import cors from 'cors'

const app = express()
const port = 4000

app.use(cors())
app.use(express.json())
app.use(express.urlencoded({ extended: true }))

app.get('/', (request, response) => {
  response.send('Hello, GraphQL!')
})

app.listen(port, () => {
  console.log(`Running a server at http://localhost:${port}`)
})

Этот блок кода создает базовый HTTP-сервер с Express. Вызывая expressфункцию, вы создаете экспресс-приложение. После настройки нескольких основных параметров для CORS и JSON вы определите, что должно быть отправлено с GETзапросом в корень ( /) с использованием app.get('/'). Наконец, используйте app.listen()для определения порта, который должен прослушивать сервер API.

Сохраните и закройте файл, когда закончите.

Теперь вы можете запустить команду для запуска сервера Node:

npm run dev

Если вы зайдете http://localhost:4000в браузере или запустите curl http://localhost:4000команду, вы увидите, что она возвращает Hello, GraphQL!значение, указывающее, что сервер Express запущен. На этом этапе вы можете начать добавлять код для обслуживания конечной точки GraphQL.

Настройка ПО промежуточного слоя HTTP-сервера GraphQL

В этом разделе вы начнете интегрировать схему GraphQL в базовый сервер Express. Вы сделаете это, определив схему, преобразователи и подключившись к хранилищу данных.

Чтобы начать интеграцию GraphQL в сервер Express, вы установите три пакета: graphql, express-graphqlи @graphql-tools/schema. Выполните следующую команду:

npm install graphql@14 express-graphql @graphql-tools/schema
  • graphql: эталонная реализация JavaScript для GraphQL.
  • express-graphql: ПО промежуточного слоя HTTP-сервера для GraphQL.
  • @graphql-tools/schema: набор утилит для более быстрой разработки GraphQL.

Вы можете импортировать эти пакеты в server.jsфайл, добавив выделенные строки:

import express from 'express'
import cors from 'cors'
import { graphqlHTTP } from 'express-graphql'
import { makeExecutableSchema } from '@graphql-tools/schema'

...

Следующим шагом является создание исполняемой схемы GraphQL.

Чтобы избежать накладных расходов на настройку базы данных, вы можете использовать хранилище в памяти для данных, которые будет запрашивать сервер GraphQL. Вы можете создать dataобъект со значениями, которые будет иметь ваша база данных. Добавьте выделенные строки в ваш файл:

import express from 'express'
import cors from 'cors'
import { graphqlHTTP } from 'express-graphql'
import { makeExecutableSchema } from '@graphql-tools/schema'

const data = {
  warriors: [
    { id: '001', name: 'Jaime' },
    { id: '002', name: 'Jorah' },
  ],
}

...

Структура данных здесь представляет собой таблицу базы данных warriors, которая имеет две строки, представленные записями Jaimeи .Jorah

Теперь, когда ваши пакеты установлены и есть некоторые данные, вы создадите схему, которая определяет API, описывая данные, доступные для запроса.

Схема GraphQL

Теперь, когда у вас есть некоторые базовые данные, вы можете приступить к созданию элементарной схемы для API, чтобы получить минимальный объем кода, необходимый для начала использования конечной точки GraphQL. Эта схема предназначена для воспроизведения чего-то, что можно было бы использовать для фэнтезийной ролевой игры, в которой есть персонажи, выполняющие такие роли, как воины, волшебники и целители. Этот пример должен быть открытым, чтобы вы могли добавлять столько, сколько хотите, например, заклинания и оружие.

Схема GraphQL основана на системе типов . Есть несколько встроенных типов, а также можно создать свой собственный тип. В этом примере вы создадите новый объект с typeименем Warriorи назначите ему два поля: idи name.

type Warrior {
  id: ID!
  name: String!
}

У idобъекта есть IDтип, и у nameобъекта есть Stringтип. Это встроенные скаляры или примитивные типы. Восклицательный знак ( !) означает, что поле не может принимать значения NULL , и для любого экземпляра этого типа потребуется значение.

Единственная дополнительная информация, необходимая для начала работы, — это базовый Queryтип, который является точкой входа в запрос GraphQL. Мы определим warriorsкак массив Warriorтипов.

type Query {
  warriors: [Warrior]
}

С этими двумя типами у вас есть допустимая схема, которую можно использовать в промежуточном программном обеспечении HTTP GraphQL. В конечном счете, схема, которую вы определяете здесь, будет передана в makeExecutableSchemaфункцию, предоставляемую graphql-toolsas typeDefs. Два свойства, передаваемые в объект makeExecutableSchemaфункции, будут следующими:

  • typeDefs: строка языка схемы GraphQL.
  • resolvers: функции, которые вызываются для выполнения поля и создания значения.

В server.js, после импорта зависимостей создайте typeDefsпеременную и назначьте схему GraphQL в виде строки, как показано здесь:

...

const data = {
  warriors: [
    { id: '001', name: 'Jaime' },
    { id: '002', name: 'Jorah' },
  ],
}

const typeDefs = `
type Warrior {
  id: ID!
  name: String!
}

type Query {
  warriors: [Warrior]
}
`

...

Теперь у вас есть набор данных, а также ваша схема, определенная как dataи typeDefsсоответственно. Далее вы создадите распознаватели, чтобы API знал, что делать с входящими запросами.

Функции преобразователя GraphQL

Резолверы — это набор функций, которые генерируют ответ для сервера GraphQL. Каждая функция резольвера имеет четыре параметра:

  • obj: родительский объект, который здесь использовать не обязательно, так как он уже является корневым или объектом верхнего уровня.
  • args: любые аргументы GraphQL, переданные в поле.
  • context: состояние, совместно используемое всеми преобразователями, часто соединение с базой данных.
  • info: Дополнительная информация .

В этом случае вы создадите преобразователь для корневого Queryтипа и вернете значение для warriors.

Чтобы начать работу с этим примером сервера, передайте хранилище данных в памяти из ранее в этом разделе, добавив выделенные строки в server.js:

...

const typeDefs = `
type Warrior {
  id: ID!
  name: String!
}

type Query {
  warriors: [Warrior]
}
`

const resolvers = {
  Query: {
    warriors: (obj, args, context, info) => context.warriors,
  },
}

...

Точка входа на сервер GraphQL будет через корневой Queryтип на преобразователях. Теперь вы добавили одну функцию разрешения, называемую warriors, которая будет возвращать значение warriorsиз context. contextэто место, где будет находиться ваша точка входа в базу данных, и для этой конкретной реализации это будет dataпеременная, содержащая ваше хранилище данных в памяти.

Каждая отдельная функция преобразователя имеет четыре параметра: obj, args, contextи info. Самый полезный и актуальный параметр для нашей схемы прямо сейчас — contextэто объект, совместно используемый распознавателями. Он часто используется в качестве соединения между сервером GraphQL и базой данных.

Наконец, когда typeDefsвсе resolversустановлено, у вас достаточно информации для создания исполняемой схемы. Добавьте выделенные строки в ваш файл:

...

const resolvers = {
  Query: {
    warriors: (obj, args, context, info) => context.warriors,
  },
}

const executableSchema = makeExecutableSchema({
  typeDefs,
  resolvers,
})

...

Функция makeExecutableSchema создает полную схему, которую вы можете передать в конечную точку GraphQL.

Теперь замените корневую конечную точку по умолчанию, которая в настоящее время возвращается Hello, GraphQL!, на следующую /graphqlконечную точку, добавив выделенные строки:

...

const executableSchema = makeExecutableSchema({
  typeDefs,
  resolvers,
})

app.use(
  '/graphql',
  graphqlHTTP({
    schema: executableSchema,
    context: data,
    graphiql: true,
  })
)

...

Соглашение заключается в том, что сервер GraphQL будет использовать /graphqlконечную точку. Использование graphqlHTTPпромежуточного программного обеспечения требует передачи схемы и контекста, которым в данном случае является ваше фиктивное хранилище данных.

Теперь у вас есть все необходимое для начала обслуживания конечной точки. Ваш server.jsкод должен выглядеть так:

import express from 'express'
import cors from 'cors'
import { graphqlHTTP } from 'express-graphql'
import { makeExecutableSchema } from '@graphql-tools/schema'

const app = express()
const port = 4000

// In-memory data store
const data = {
  warriors: [
    { id: '001', name: 'Jaime' },
    { id: '002', name: 'Jorah' },
  ],
}

// Schema
const typeDefs = `
type Warrior {
  id: ID!
  name: String!
}

type Query {
  warriors: [Warrior]
}
`

// Resolver for warriors
const resolvers = {
  Query: {
    warriors: (obj, args, context) => context.warriors,
  },
}

const executableSchema = makeExecutableSchema({
  typeDefs,
  resolvers,
})

app.use(cors())
app.use(express.json())
app.use(express.urlencoded({ extended: true }))

// Entrypoint
app.use(
  '/graphql',
  graphqlHTTP({
    schema: executableSchema,
    context: data,
    graphiql: true,
  })
)

app.listen(port, () => {
  console.log(`Running a server at http://localhost:${port}`)
})

Сохраните и закройте файл, когда закончите.

Теперь вы сможете перейти к http://localhost:4000/graphqlсвоей схеме и изучить ее с помощью GraphiQL IDE .

Теперь ваш API GraphQL завершен на основе схемы и распознавателей, созданных в этом разделе. В следующем разделе вы будете использовать интегрированную среду разработки GraphiQL для отладки и понимания вашей схемы.

Использование интегрированной среды разработки GraphiQL

Поскольку вы применили graphiqlопцию trueпромежуточного программного обеспечения GraphQL, у вас есть доступ к интегрированной среде разработки (IDE) GraphiQL. Если вы посетили конечную точку GraphQL в окне браузера, вы окажетесь в GraphiQL.

GraphiQL — это встроенный в браузер инструмент для написания, проверки и тестирования запросов GraphQL. Теперь вы можете протестировать свой сервер GraphQL, чтобы убедиться, что он возвращает правильные данные.

Сделайте запрос для warriors, запросив свойства idи . nameВ браузере добавьте следующие строки в левую панель GraphiQL:

{
  warriors {
    id
    name
  }
}

Отправьте запрос, нажав стрелку воспроизведения в левом верхнем углу, и вы должны увидеть возвращаемое значение в формате JSON справа:

Output{
  "data": {
    "warriors": [
      { "id": "001", "name": "Jaime" },
      { "id": "002", "name": "Jorah" }
    ]
  }
}

Если вы удалите одно из полей в запросе, вы увидите соответствующее изменение возвращаемого значения. Например, если вы хотите получить только nameполе, вы можете написать запрос следующим образом:

{
  warriors {
    name
  }
}

И теперь ваш ответ будет выглядеть так:

Output{
  "data": {
    "warriors": [{ "name": "Jaime" }, { "name": "Jorah" }]
  }
}

Возможность запрашивать только те поля, которые вам нужны, является одним из мощных аспектов GraphQL и делает его языком , управляемым клиентом .

Вернувшись в GraphiQL, если вы нажмете « Документы » до упора вправо, откроется боковая панель с надписью Documentation Explorer . На этой боковой панели вы можете щелкнуть документацию, чтобы просмотреть схему более подробно.

Теперь ваш API готов, и вы узнали, как использовать его из GraphiQL. Следующим шагом будет выполнение реальных запросов от клиента к вашему GraphQL API.

Запрос API GraphQL от клиента

Как и в случае с REST API , клиент может взаимодействовать с GraphQL API, отправляя HTTP-запросы по сети. Поскольку вы можете использовать встроенные API-интерфейсы браузера, например fetch, для выполнения сетевых запросов, вы также можете использовать fetchдля запросов GraphQL.

Для очень простого примера создайте скелет HTML в index.htmlфайле с <pre>тегом:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>GraphQL Client</title>
  </head>

  <pre><!-- data will be displayed here --></pre>

  <body>
    <script>
      // Add query here
    </script>
  </body>
</html>

В scriptтеге сделайте асинхронную функцию, которая отправляет POSTзапрос к GraphQL API:

...
<body>
    <script>
      async function queryGraphQLServer() {
        const response = await fetch('http://localhost:4000/graphql', {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
          },
          body: JSON.stringify({
            query: '{ warriors { name } }',
          }),
        })
        const data = await response.json()
				
        // Append data to the pre tag
        const pre = document.querySelector('pre')
        pre.textContent = JSON.stringify(data, null, 2) // Pretty-print the JSON
      }

      queryGraphQLServer()
    </script>
  </body>
...

Заголовок Content-Typeдолжен иметь значение application/json, а запрос должен быть передан в теле в виде строки. Скрипт вызовет функцию, чтобы сделать запрос, и установит ответ в preтеге.

Вот полный index.htmlкод.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>GraphQL</title>
  </head>

  <pre></pre>

  <body>
    <script>
      async function queryGraphQLServer() {
        const response = await fetch('http://localhost:4000/graphql', {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
          },
          body: JSON.stringify({
            query: '{ warriors { name } }',
          }),
        })
        const data = await response.json()

        const pre = document.querySelector('pre')
        pre.textContent = JSON.stringify(data, null, 2) // Pretty-print the JSON
      }

      queryGraphQLServer()
    </script>
  </body>
</html>

Сохраните и закройте файл, когда закончите.

Теперь, когда вы просматриваете index.htmlфайл в браузере, вы увидите исходящий сетевой запрос к http://localhost:4000/graphqlконечной точке, который вернет a 200с данными. Вы можете просмотреть этот сетевой запрос, открыв Инструменты разработчика и перейдя на вкладку Сеть .

Если ваш запрос прошел и вы получили 200ответ с данными от GraphQL API, поздравляем! Вы создали свой первый API-сервер GraphQL.

Вывод

В этом руководстве вы создали сервер GraphQL API, используя платформу Express в Node.js. Сервер GraphQL состоит из одной /graphqlконечной точки, которая может обрабатывать входящие запросы для запроса хранилища данных. В вашем API была схема с базовым Queryтипом, настраиваемым Warriorтипом и преобразователем для получения правильных данных для этих типов.

Надеемся, что эта статья помогла демистифицировать GraphQL и открыла новые идеи и возможности того, чего можно достичь с помощью GraphQL. Существует множество инструментов, которые могут помочь с более сложными аспектами работы с GraphQL, такими как аутентификация, безопасность и кэширование, но изучение того, как настроить сервер API самым простым способом, должно помочь вам понять основы GraphQL.

Оригинальный источник статьи на https://www.digitalocean.com

#graphql #api #express #expressjs #node #nodejs 

NBB: Ad-hoc CLJS Scripting on Node.js

Nbb

Not babashka. Node.js babashka!?

Ad-hoc CLJS scripting on Node.js.

Status

Experimental. Please report issues here.

Goals and features

Nbb's main goal is to make it easy to get started with ad hoc CLJS scripting on Node.js.

Additional goals and features are:

  • Fast startup without relying on a custom version of Node.js.
  • Small artifact (current size is around 1.2MB).
  • First class macros.
  • Support building small TUI apps using Reagent.
  • Complement babashka with libraries from the Node.js ecosystem.

Requirements

Nbb requires Node.js v12 or newer.

How does this tool work?

CLJS code is evaluated through SCI, the same interpreter that powers babashka. Because SCI works with advanced compilation, the bundle size, especially when combined with other dependencies, is smaller than what you get with self-hosted CLJS. That makes startup faster. The trade-off is that execution is less performant and that only a subset of CLJS is available (e.g. no deftype, yet).

Usage

Install nbb from NPM:

$ npm install nbb -g

Omit -g for a local install.

Try out an expression:

$ nbb -e '(+ 1 2 3)'
6

And then install some other NPM libraries to use in the script. E.g.:

$ npm install csv-parse shelljs zx

Create a script which uses the NPM libraries:

(ns script
  (:require ["csv-parse/lib/sync$default" :as csv-parse]
            ["fs" :as fs]
            ["path" :as path]
            ["shelljs$default" :as sh]
            ["term-size$default" :as term-size]
            ["zx$default" :as zx]
            ["zx$fs" :as zxfs]
            [nbb.core :refer [*file*]]))

(prn (path/resolve "."))

(prn (term-size))

(println (count (str (fs/readFileSync *file*))))

(prn (sh/ls "."))

(prn (csv-parse "foo,bar"))

(prn (zxfs/existsSync *file*))

(zx/$ #js ["ls"])

Call the script:

$ nbb script.cljs
"/private/tmp/test-script"
#js {:columns 216, :rows 47}
510
#js ["node_modules" "package-lock.json" "package.json" "script.cljs"]
#js [#js ["foo" "bar"]]
true
$ ls
node_modules
package-lock.json
package.json
script.cljs

Macros

Nbb has first class support for macros: you can define them right inside your .cljs file, like you are used to from JVM Clojure. Consider the plet macro to make working with promises more palatable:

(defmacro plet
  [bindings & body]
  (let [binding-pairs (reverse (partition 2 bindings))
        body (cons 'do body)]
    (reduce (fn [body [sym expr]]
              (let [expr (list '.resolve 'js/Promise expr)]
                (list '.then expr (list 'clojure.core/fn (vector sym)
                                        body))))
            body
            binding-pairs)))

Using this macro we can look async code more like sync code. Consider this puppeteer example:

(-> (.launch puppeteer)
      (.then (fn [browser]
               (-> (.newPage browser)
                   (.then (fn [page]
                            (-> (.goto page "https://clojure.org")
                                (.then #(.screenshot page #js{:path "screenshot.png"}))
                                (.catch #(js/console.log %))
                                (.then #(.close browser)))))))))

Using plet this becomes:

(plet [browser (.launch puppeteer)
       page (.newPage browser)
       _ (.goto page "https://clojure.org")
       _ (-> (.screenshot page #js{:path "screenshot.png"})
             (.catch #(js/console.log %)))]
      (.close browser))

See the puppeteer example for the full code.

Since v0.0.36, nbb includes promesa which is a library to deal with promises. The above plet macro is similar to promesa.core/let.

Startup time

$ time nbb -e '(+ 1 2 3)'
6
nbb -e '(+ 1 2 3)'   0.17s  user 0.02s system 109% cpu 0.168 total

The baseline startup time for a script is about 170ms seconds on my laptop. When invoked via npx this adds another 300ms or so, so for faster startup, either use a globally installed nbb or use $(npm bin)/nbb script.cljs to bypass npx.

Dependencies

NPM dependencies

Nbb does not depend on any NPM dependencies. All NPM libraries loaded by a script are resolved relative to that script. When using the Reagent module, React is resolved in the same way as any other NPM library.

Classpath

To load .cljs files from local paths or dependencies, you can use the --classpath argument. The current dir is added to the classpath automatically. So if there is a file foo/bar.cljs relative to your current dir, then you can load it via (:require [foo.bar :as fb]). Note that nbb uses the same naming conventions for namespaces and directories as other Clojure tools: foo-bar in the namespace name becomes foo_bar in the directory name.

To load dependencies from the Clojure ecosystem, you can use the Clojure CLI or babashka to download them and produce a classpath:

$ classpath="$(clojure -A:nbb -Spath -Sdeps '{:aliases {:nbb {:replace-deps {com.github.seancorfield/honeysql {:git/tag "v2.0.0-rc5" :git/sha "01c3a55"}}}}}')"

and then feed it to the --classpath argument:

$ nbb --classpath "$classpath" -e "(require '[honey.sql :as sql]) (sql/format {:select :foo :from :bar :where [:= :baz 2]})"
["SELECT foo FROM bar WHERE baz = ?" 2]

Currently nbb only reads from directories, not jar files, so you are encouraged to use git libs. Support for .jar files will be added later.

Current file

The name of the file that is currently being executed is available via nbb.core/*file* or on the metadata of vars:

(ns foo
  (:require [nbb.core :refer [*file*]]))

(prn *file*) ;; "/private/tmp/foo.cljs"

(defn f [])
(prn (:file (meta #'f))) ;; "/private/tmp/foo.cljs"

Reagent

Nbb includes reagent.core which will be lazily loaded when required. You can use this together with ink to create a TUI application:

$ npm install ink

ink-demo.cljs:

(ns ink-demo
  (:require ["ink" :refer [render Text]]
            [reagent.core :as r]))

(defonce state (r/atom 0))

(doseq [n (range 1 11)]
  (js/setTimeout #(swap! state inc) (* n 500)))

(defn hello []
  [:> Text {:color "green"} "Hello, world! " @state])

(render (r/as-element [hello]))

Promesa

Working with callbacks and promises can become tedious. Since nbb v0.0.36 the promesa.core namespace is included with the let and do! macros. An example:

(ns prom
  (:require [promesa.core :as p]))

(defn sleep [ms]
  (js/Promise.
   (fn [resolve _]
     (js/setTimeout resolve ms))))

(defn do-stuff
  []
  (p/do!
   (println "Doing stuff which takes a while")
   (sleep 1000)
   1))

(p/let [a (do-stuff)
        b (inc a)
        c (do-stuff)
        d (+ b c)]
  (prn d))
$ nbb prom.cljs
Doing stuff which takes a while
Doing stuff which takes a while
3

Also see API docs.

Js-interop

Since nbb v0.0.75 applied-science/js-interop is available:

(ns example
  (:require [applied-science.js-interop :as j]))

(def o (j/lit {:a 1 :b 2 :c {:d 1}}))

(prn (j/select-keys o [:a :b])) ;; #js {:a 1, :b 2}
(prn (j/get-in o [:c :d])) ;; 1

Most of this library is supported in nbb, except the following:

  • destructuring using :syms
  • property access using .-x notation. In nbb, you must use keywords.

See the example of what is currently supported.

Examples

See the examples directory for small examples.

Also check out these projects built with nbb:

API

See API documentation.

Migrating to shadow-cljs

See this gist on how to convert an nbb script or project to shadow-cljs.

Build

Prequisites:

  • babashka >= 0.4.0
  • Clojure CLI >= 1.10.3.933
  • Node.js 16.5.0 (lower version may work, but this is the one I used to build)

To build:

  • Clone and cd into this repo
  • bb release

Run bb tasks for more project-related tasks.

Download Details:
Author: borkdude
Download Link: Download The Source Code
Official Website: https://github.com/borkdude/nbb 
License: EPL-1.0

#node #javascript

Hire Dedicated Node.js Developers - Hire Node.js Developers

If you look at the backend technology used by today’s most popular apps there is one thing you would find common among them and that is the use of NodeJS Framework. Yes, the NodeJS framework is that effective and successful.

If you wish to have a strong backend for efficient app performance then have NodeJS at the backend.

WebClues Infotech offers different levels of experienced and expert professionals for your app development needs. So hire a dedicated NodeJS developer from WebClues Infotech with your experience requirement and expertise.

So what are you waiting for? Get your app developed with strong performance parameters from WebClues Infotech

For inquiry click here: https://www.webcluesinfotech.com/hire-nodejs-developer/

Book Free Interview: https://bit.ly/3dDShFg

#hire dedicated node.js developers #hire node.js developers #hire top dedicated node.js developers #hire node.js developers in usa & india #hire node js development company #hire the best node.js developers & programmers

Aria Barnes

Aria Barnes

1622719015

Why use Node.js for Web Development? Benefits and Examples of Apps

Front-end web development has been overwhelmed by JavaScript highlights for quite a long time. Google, Facebook, Wikipedia, and most of all online pages use JS for customer side activities. As of late, it additionally made a shift to cross-platform mobile development as a main technology in React Native, Nativescript, Apache Cordova, and other crossover devices. 

Throughout the most recent couple of years, Node.js moved to backend development as well. Designers need to utilize a similar tech stack for the whole web project without learning another language for server-side development. Node.js is a device that adjusts JS usefulness and syntax to the backend. 

What is Node.js? 

Node.js isn’t a language, or library, or system. It’s a runtime situation: commonly JavaScript needs a program to work, however Node.js makes appropriate settings for JS to run outside of the program. It’s based on a JavaScript V8 motor that can run in Chrome, different programs, or independently. 

The extent of V8 is to change JS program situated code into machine code — so JS turns into a broadly useful language and can be perceived by servers. This is one of the advantages of utilizing Node.js in web application development: it expands the usefulness of JavaScript, permitting designers to coordinate the language with APIs, different languages, and outside libraries.

What Are the Advantages of Node.js Web Application Development? 

Of late, organizations have been effectively changing from their backend tech stacks to Node.js. LinkedIn picked Node.js over Ruby on Rails since it took care of expanding responsibility better and decreased the quantity of servers by multiple times. PayPal and Netflix did something comparative, just they had a goal to change their design to microservices. We should investigate the motivations to pick Node.JS for web application development and when we are planning to hire node js developers. 

Amazing Tech Stack for Web Development 

The principal thing that makes Node.js a go-to environment for web development is its JavaScript legacy. It’s the most well known language right now with a great many free devices and a functioning local area. Node.js, because of its association with JS, immediately rose in ubiquity — presently it has in excess of 368 million downloads and a great many free tools in the bundle module. 

Alongside prevalence, Node.js additionally acquired the fundamental JS benefits: 

  • quick execution and information preparing; 
  • exceptionally reusable code; 
  • the code is not difficult to learn, compose, read, and keep up; 
  • tremendous asset library, a huge number of free aides, and a functioning local area. 

In addition, it’s a piece of a well known MEAN tech stack (the blend of MongoDB, Express.js, Angular, and Node.js — four tools that handle all vital parts of web application development). 

Designers Can Utilize JavaScript for the Whole Undertaking 

This is perhaps the most clear advantage of Node.js web application development. JavaScript is an unquestionable requirement for web development. Regardless of whether you construct a multi-page or single-page application, you need to know JS well. On the off chance that you are now OK with JavaScript, learning Node.js won’t be an issue. Grammar, fundamental usefulness, primary standards — every one of these things are comparable. 

In the event that you have JS designers in your group, it will be simpler for them to learn JS-based Node than a totally new dialect. What’s more, the front-end and back-end codebase will be basically the same, simple to peruse, and keep up — in light of the fact that they are both JS-based. 

A Quick Environment for Microservice Development 

There’s another motivation behind why Node.js got famous so rapidly. The environment suits well the idea of microservice development (spilling stone monument usefulness into handfuls or many more modest administrations). 

Microservices need to speak with one another rapidly — and Node.js is probably the quickest device in information handling. Among the fundamental Node.js benefits for programming development are its non-obstructing algorithms.

Node.js measures a few demands all at once without trusting that the first will be concluded. Many microservices can send messages to one another, and they will be gotten and addressed all the while. 

Versatile Web Application Development 

Node.js was worked in view of adaptability — its name really says it. The environment permits numerous hubs to run all the while and speak with one another. Here’s the reason Node.js adaptability is better than other web backend development arrangements. 

Node.js has a module that is liable for load adjusting for each running CPU center. This is one of numerous Node.js module benefits: you can run various hubs all at once, and the environment will naturally adjust the responsibility. 

Node.js permits even apportioning: you can part your application into various situations. You show various forms of the application to different clients, in light of their age, interests, area, language, and so on. This builds personalization and diminishes responsibility. Hub accomplishes this with kid measures — tasks that rapidly speak with one another and share a similar root. 

What’s more, Node’s non-hindering solicitation handling framework adds to fast, letting applications measure a great many solicitations. 

Control Stream Highlights

Numerous designers consider nonconcurrent to be one of the two impediments and benefits of Node.js web application development. In Node, at whatever point the capacity is executed, the code consequently sends a callback. As the quantity of capacities develops, so does the number of callbacks — and you end up in a circumstance known as the callback damnation. 

In any case, Node.js offers an exit plan. You can utilize systems that will plan capacities and sort through callbacks. Systems will associate comparable capacities consequently — so you can track down an essential component via search or in an envelope. At that point, there’s no compelling reason to look through callbacks.

 

Final Words

So, these are some of the top benefits of Nodejs in web application development. This is how Nodejs is contributing a lot to the field of web application development. 

I hope now you are totally aware of the whole process of how Nodejs is really important for your web project. If you are looking to hire a node js development company in India then I would suggest that you take a little consultancy too whenever you call. 

Good Luck!

Original Source

#node.js development company in india #node js development company #hire node js developers #hire node.js developers in india #node.js development services #node.js development

Node JS Development Company| Node JS Web Developers-SISGAIN

Top organizations and start-ups hire Node.js developers from SISGAIN for their strategic software development projects in Illinois, USA. On the off chance that you are searching for a first rate innovation to assemble a constant Node.js web application development or a module, Node.js applications are the most appropriate alternative to pick. As Leading Node.js development company, we leverage our profound information on its segments and convey solutions that bring noteworthy business results. For more information email us at hello@sisgain.com

#node.js development services #hire node.js developers #node.js web application development #node.js development company #node js application