使用 GraphQL、MongoDB、Hapi 和 Swagger 巧妙地构建 API 的技巧

前端

2023-10-20 23:12:54

导言

在当今数字时代，应用程序编程接口（API）已成为连接不同系统和服务的命脉。它们使应用程序能够共享数据、功能，并实现前所未有的集成水平。

在构建 API 时，有许多技术可供选择。对于希望构建强大、灵活且可扩展的 API 的开发人员来说，Node.js、GraphQL、MongoDB、Hapi 和 Swagger 的组合是一个令人信服的选择。

在这篇深入的文章中，我们将深入研究使用这五项强大技术的协同效应，并逐步指导您构建一个基于 Node.js、由 MongoDB 数据驱动的 API。我们将探索：

每个技术如何贡献于 API 的构建过程
如何结合使用这些技术创建可重用且可扩展的 API
实施最佳实践以确保 API 的性能和安全性

Node.js：服务器端运行时

Node.js 是一个基于 JavaScript 的服务器端运行时环境，以其高性能、非阻塞 I/O 和事件驱动的架构而闻名。它提供了一个健壮且可扩展的基础，非常适合构建实时 API 和微服务。

GraphQL：数据查询语言

GraphQL 是一种用于查询和操作数据的强大且灵活的数据查询语言。它使客户端能够以声明式的方式请求特定数据，并且只返回所需的数据。这减少了网络流量，提高了性能并简化了客户端开发。

MongoDB：文档数据库

MongoDB 是一个文档数据库，它存储数据作为 JSON 文档。它的模式灵活性、可扩展性以及对 JSON 的内置支持使其成为构建 API 的绝佳选择，其中数据结构可能随时间变化。

Hapi：API 框架

Hapi 是一个功能强大且灵活的 API 框架，旨在帮助开发人员快速轻松地构建健壮且可扩展的 API。它提供了一系列开箱即用的功能，例如路由、验证和错误处理。

Swagger：API 文档和规范

Swagger 是一套工具和规范，用于、文档化和测试 RESTful API。它使开发人员能够以一种标准化且可机器可读的方式定义 API 的结构和行为。

构建 API 的分步指南

1. 安装依赖项

使用 npm 安装 Node.js、GraphQL、MongoDB、Hapi 和 Swagger 所需的依赖项：

npm install express graphql mongodb hapi swagger-jsdoc

2. 设置 MongoDB

启动 MongoDB 服务器并创建一个名为 "mydatabase" 的数据库。

3. 定义 GraphQL 架构

定义 GraphQL 架构以 API 的数据模型：

type Query {
  allPosts: [Post]
  getPost(id: ID!): Post
}

type Post {
  id: ID!
  title: String
  content: String
}

4. 创建 Hapi 服务器

使用 Hapi 创建一个 HTTP 服务器：

const server = new Hapi.Server({
  host: 'localhost',
  port: 3000
});

5. 实现 GraphQL 解析器

使用 GraphQL 解析器实现架构中定义的查询：

const resolvers = {
  Query: {
    allPosts: async () => {
      return await Post.find();
    },
    getPost: async (parent, args) => {
      return await Post.findById(args.id);
    }
  }
};

6. 配置 Swagger 文档

使用 Swagger-jsdoc 配置 API 文档：

const options = {
  swaggerDefinition: {
    info: {
      title: 'My API',
      version: '1.0.0'
    }
  },
  apis: ['./routes/*.js']
};

const swaggerPlugin = swaggerJsdoc(options);

7. 启动服务器

使用 Hapi 启动服务器并注册 GraphQL 和 Swagger 插件：

server.register([
  {
    plugin: require('graphql-hapi'),
    options: {
      path: '/graphql',
      graphqlOptions: {
        schema: schema,
        resolvers: resolvers
      },
      route: {
        cors: true
      }
    }
  },
  {
    plugin: swaggerPlugin
  }
]);

server.start((err) => {
  if (err) {
    throw err;
  }

  console.log(`Server running at: ${server.info.uri}`);
});