GraphQL - 示例

在本章中，我们将创建一个返回问候消息 HelloWorld 的简单 API，并使用 GraphiQL 访问它。

示例

此示例基于 NodeJS、Express 和 Apollo 服务器。我们将学习将所有概念与以下步骤结合起来 −

步骤 1 − 设置 Express

ExpressJS 是一个 Web 应用程序框架，可帮助构建网站和 Web 应用程序。在此示例中，我们将在 Express 框架之上构建一个 GraphQL API。

下一步是创建一个文件夹 hello-world-server 并从终端导航到同一文件夹。添加 package.json，并为包命名。由于此包仅在内部使用，我们可以将其声明为私有包。

{
    "name":"hello-world-server",
    "private":true
}

安装 Express 服务器的依赖项，如下所示 −

C:\Users\Admin\hello-world-server>npm install express body-parser cors

body-parser 是一个中间件包，可帮助 Express 高效处理 HTTP Post 请求。cors 是另一个处理跨源资源共享的中间件包。

在项目文件夹中创建一个 server.js 文件，并在其中输入以下内容 −

const bodyParser = require('body-parser')
   const cors = require('cors')
   const express = require('express')
   const port = process.env.PORT|| 9000
   const app = express()
   
   //注册中间件
   app.use(bodyParser.json() , cors())
   app.listen(port, () =>  console.log(`server is up and running at ${port}`)

要验证 Express 服务器是否已启动并正在运行，请在终端窗口中执行以下代码 −

C:\Users\Admin\hello-world-server>node server.js

服务器控制台中显示以下输出。这表明 Express 服务器正在端口 9000 上运行。

服务器已启动并在 9000 上运行

如果打开浏览器并输入 http://localhost:9000，您将看到以下屏幕 −

要停止服务器，请按 Ctrl + C。

第 2 步 −安装 GraphQL 和 Apollo Server

现在 Express 已配置完毕，下一步是下载以下 GraphQL 依赖项 −

• graphql
• graphql-tools
• apollo-server-express@1

我们将使用 Apollo server v1.0，因为它是一个稳定版本。输入以下命令来安装这些依赖项 −

C:\Users\Admin\hello-world-server>npm install graphql graphql-tools apollo-server-express@1

我们可以通过检查我们之前创建的 package.json 文件来验证这些依赖项是否安装成功。

{
   "name": "hello-world-server",
   "private": true,
   
   "dependencies": {
      "apollo-server-express": "^1.4.0",
      "body-parser": "^1.18.3",
      "cors": "^2.8.4",
      "express": "^4.16.3",
      "graphql": "^0.13.2",
      "graphql-tools": "^3.1.1"
   }
}

第 3 步 − 定义架构

GraphQL 架构定义可以从服务中获取哪种类型的对象以及它具有哪些字段。可以使用 GraphQL 架构定义语言 定义架构。现在，在 server.js 文件中添加以下代码片段 −

// 添加类型定义
const typeDefinition = `
   type Query  {
      greeting: String
   }

此处，查询包含一个返回 string 值的 greeting 属性。

第 4 步 − 创建解析器

创建解析器的第一步是添加一些代码来处理问候语字段的请求。这在 resolver 中指定。解析器函数的结构必须与架构匹配。在 server.js 文件中添加以下代码片段。

// 添加解析器
const  resolverObject = {
   Query : {
      greeting: () => 'Hello GraphQL  From TutorialsPoint !!'
   }
}

第二步是使用 makeExecutableSchema 绑定架构和解析器。此函数在 graphql-tools 模块中预定义。在 server.js 文件中添加以下代码片段。

const {makeExecutableSchema} = require('graphql-tools')
const schema = makeExecutableSchema({typeDefs:typeDefinition, resolvers:resolverObject})

第 5 步 − 定义从 ReactJS/GraphiQL 应用程序获取数据的路由

在 server.js 文件中添加以下代码片段−

const {graphqlExpress, graphiqlExpress} = require('apollo-server-express')

   //为 graphql 和 graphiql 创建路由
   app.use('/graphql',graphqlExpress({schema}))
   
   app.use('/graphiql',graphiqlExpress({endpointURL:'/graphql'}))

graphqlExpress 函数有助于注册路由 http://localhost:9000/graphql。ReactJS 应用程序可以使用此端点查询数据。同样，graphqliExpress 函数有助于注册路由 http://localhost:9000/graphiql。GraphiQL 浏览器客户端将使用它来测试 API。

完整的 server.js 代码如下所示 −

const bodyParser = require('body-parser')
const cors = require('cors')
const express = require('express')
const port = process.env.PORT||9000
const app = express()

app.use(bodyParser.json() , cors())
const typeDefinition = `
type Query  {
   greeting: String
}`
const  resolverObject = {
   Query : {
      greeting: () => 'Hello GraphQL  From TutorialsPoint !!'
   }
}
const {makeExecutableSchema} = require('graphql-tools')

const schema = makeExecutableSchema({typeDefs:typeDefinition, resolvers:resolverObject})

const {graphqlExpress,graphiqlExpress} = require('apollo-server-express')

app.use('/graphql',graphqlExpress({schema}))
app.use('/graphiql',graphiqlExpress({endpointURL:'/graphql'}))
app.listen(port, () =>  console.log(`server is up and running ${port}`))

第 6 步 − 启动应用程序

使用 Node.js 执行 server.js，如下所示 −

C:\Users\Admin\hello-world-server>node server.js

第 7 步 − 测试 GraphQL API

打开浏览器并输入 http://localhost:9000/graphiql。在 GraphiQL 的查询选项卡中，输入以下内容 −

{
   greeting
}

服务器的响应如下所示 −

{
   "data": {
      "greeting": "Hello GraphQL From TutorialsPoint !!"
   }
}

下图说明了响应 −

注意 − 请确保使用 Apollo Server 版本 1.0。