26 使用 GraphQL 构建 API

在本小节中，我们将学习如何使用 GraphQL 来构建一个 API，为我们的 Hexo 网站提供数据支持。GraphQL 是一个用于 API 的查询语言，可以让客户端以灵活的方式获取所需的数据。

一、什么是 GraphQL？

GraphQL 由 Facebook 开发，用于替代 RESTful API。其优势在于客户端可以精确指定所需要的数据结构，从而减少了不必要的数据传输。与 REST API 不同，GraphQL 使用单一的端点来处理所有的请求。

二、安装和设置

首先，我们需要安装 graphql 和 express-graphql 包，它们将帮助我们在 Hexo 项目中实现 GraphQL API。

在命令行中，运行以下命令：

npm install graphql express-graphql

1. 创建 GraphQL Schema

接下来，我们需要定义我们的 GraphQL Schema。Schema 定义了 API 的数据结构和操作。

在 Hexo 项目的 server 目录下创建一个新文件 schema.js，并在其中定义我们的 Schema：

const { GraphQLObjectType, GraphQLSchema, GraphQLString, GraphQLList } = require('graphql');

// 定义 Post 类型
const PostType = new GraphQLObjectType({
  name: 'Post',
  fields: () => ({
    title: { type: GraphQLString },
    content: { type: GraphQLString },
  }),
});

// 根查询
const RootQuery = new GraphQLObjectType({
  name: 'RootQueryType',
  fields: {
    posts: {
      type: new GraphQLList(PostType),
      resolve(parent, args) {
        // 这里应该返回 Hexo 的文章数据，以下是示例：
        return [
          { title: '第一篇文章', content: '这是第一篇文章的内容' },
          { title: '第二篇文章', content: '这是第二篇文章的内容' },
        ];
      },
    },
  },
});

// 创建 Schema
module.exports = new GraphQLSchema({
  query: RootQuery,
});

2. 设置 Express 和 GraphQL

我们需要在 Hexo 的服务器中集成 GraphQL。打开 Hexo 项目的 server.js 文件，并进行如下修改：

const express = require('express');
const { graphqlHTTP } = require('express-graphql');
const schema = require('./schema');

const app = express();

// GraphQL API 端点
app.use('/graphql', graphqlHTTP({
  schema: schema,
  graphiql: true, // 启用 graphiql 界面
}));

// 启动服务器
const PORT = process.env.PORT || 4000;
app.listen(PORT, () => {
  console.log(`Server is running on http://localhost:${PORT}/graphql`);
});

3. 测试 GraphQL API

此时，我们的 API 已经设置完成。启动 Hexo 服务器，然后在浏览器中访问 http://localhost:4000/graphql，你会看到 graphiql 界面。

在查询输入框中，你可以输入以下查询来获取文章信息：

{
  posts {
    title
    content
  }
}

点击 Execute 按钮，你将看到返回的文章数据。

三、小结

在本小节中，我们详细介绍了如何使用 GraphQL 构建一个基础的 API。我们定义了 GraphQL Schema，并在 Hexo 项目中集成了 Express 和 GraphQL 进行数据查询。

使用 GraphQL，我们可以轻松扩展 API，添加更多的查询和类型，以支持更复杂的数据交互。