在 Fastify 上使用 Swagger 文档 API-JavaScript中文网-JavaScript教程资源分享门户

Fastify 是一个快速和低开销的 Web 框架，它提供了强大的插件机制，可用于构建高效的 Web 应用程序。而 Swagger 是一个流行的 API 文档工具，可以帮助开发者快速创建和维护 API 文档。在本文中，我们将介绍如何在 Fastify 上使用 Swagger 文档 API。

安装 Fastify 和 Swagger

首先，我们需要安装 Fastify 和 Swagger。你可以使用 npm 或 yarn 安装它们。

npm install fastify swagger-ui-fastify

或者

yarn add fastify swagger-ui-fastify

创建 Fastify 应用程序

接下来，我们需要创建一个 Fastify 应用程序。在这个例子中，我们将创建一个简单的 API，它将返回一个 JSON 对象，其中包含一些用户信息。

// javascriptcn.com 代码示例
const fastify = require('fastify')({ logger: true })

fastify.get('/users', async (request, reply) => {
  return {
    users: [
      { id: 1, name: 'John Doe', email: 'john.doe@example.com' },
      { id: 2, name: 'Jane Doe', email: 'jane.doe@example.com' },
    ]
  }
})

fastify.listen(3000, (err, address) => {
  if (err) {
    fastify.log.error(err)
    process.exit(1)
  }
  fastify.log.info(`server listening on ${address}`)
})

这个应用程序将在 http://localhost:3000 上监听请求，并返回一个包含用户信息的 JSON 对象。

配置 Swagger

现在，我们需要配置 Swagger。我们将使用 swagger-ui-fastify 插件来集成 Swagger UI 到 Fastify 应用程序中。

// javascriptcn.com 代码示例
const fastify = require('fastify')({ logger: true })
const swagger = require('fastify-swagger')
const swaggerConfig = require('./swagger-config')

fastify.register(swagger, {
  routePrefix: '/docs',
  swagger: swaggerConfig,
  exposeRoute: true
})

fastify.get('/users', async (request, reply) => {
  return {
    users: [
      { id: 1, name: 'John Doe', email: 'john.doe@example.com' },
      { id: 2, name: 'Jane Doe', email: 'jane.doe@example.com' },
    ]
  }
})

fastify.listen(3000, (err, address) => {
  if (err) {
    fastify.log.error(err)
    process.exit(1)
  }
  fastify.log.info(`server listening on ${address}`)
})

在这个例子中，我们使用 register 方法来注册 swagger 插件。我们指定了一个路由前缀为 /docs，并将 Swagger 配置对象传递给 swagger 选项。我们还将 exposeRoute 选项设置为 true，以便在应用程序中公开 Swagger UI 路由。

我们还需要创建一个 swagger-config.js 文件，其中包含 Swagger 配置对象。

// javascriptcn.com 代码示例
module.exports = {
  openapi: '3.0.0',
  info: {
    title: 'Fastify API',
    version: '1.0.0'
  },
  servers: [
    {
      url: 'http://localhost:3000',
      description: 'Development server'
    }
  ],
  paths: {
    '/users': {
      get: {
        summary: 'Get users',
        description: 'Returns a list of users',
        responses: {
          200: {
            description: 'Successful response',
            content: {
              'application/json': {
                schema: {
                  type: 'object',
                  properties: {
                    users: {
                      type: 'array',
                      items: {
                        type: 'object',
                        properties: {
                          id: { type: 'integer' },
                          name: { type: 'string' },
                          email: { type: 'string' }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

在这个文件中，我们定义了 OpenAPI 规范。我们指定了 API 的标题、版本和服务器 URL。我们还定义了一个 /users 路径，它包含一个 GET 操作，该操作返回一个包含用户信息的 JSON 对象。

运行应用程序并查看 Swagger 文档

现在，我们可以运行应用程序并查看 Swagger 文档。在终端中运行以下命令：

node index.js

然后在浏览器中打开 http://localhost:3000/docs，你应该能够看到 Swagger UI，它显示了我们在 swagger-config.js 文件中定义的 /users 路径的文档。你可以使用 Swagger UI 来测试 API 并查看返回的 JSON 数据。

总结

在本文中，我们介绍了如何在 Fastify 上使用 Swagger 文档 API。我们创建了一个简单的 API，并使用 swagger-ui-fastify 插件将 Swagger UI 集成到应用程序中。我们还定义了一个 OpenAPI 规范，用于描述 API 的路径和操作。这些步骤可以帮助开发者快速创建和维护 API 文档，并提高应用程序的可读性和可维护性。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/653ba8347d4982a6eb5f810e