apisguru/graphql-faker

GraphQL Faker

https://github.com/APIs-guru/graphql-faker/workflows/CI/badge.svg?branch=master](https://github.com/APIs-guru/graphql-faker/actions?query=branch%3Amaster) ![npm]([] ![David]([] ![David]([***]

镜像概述和主要用途

GraphQL Faker 是一个无需编码即可使用https://github.com/Marak/faker.js%E6%8F%90%E4%BE%9B%E7%9A%84%E7%9C%9F%E5%AE%9E%E6%95%B0%E6%8D%AE%E6%A8%A1%E6%8B%9F%E6%9C%AA%E6%9D%A5API%E6%88%96%E6%89%A9%E5%B1%95%E7%8E%B0%E6%9C%89API%E7%9A%84%E5%B7%A5%E5%85%B7%E3%80%82%E5%8F%AA%E9%9C%80%E7%BC%96%E5%86%99GraphQL SDL，即可快速生成带有虚假数据的GraphQL服务。SDL编辑器中提供示例，支持在现有API基础上混合真实数据和模拟数据。

核心功能和特性

• 丰富的虚假数据类型：支持60+种不同类型的虚假数据，如streetAddress（街道地址）、firstName（名）、lastName（姓）、imageUrl（图片URL）、lorem（随机文本）、semver（语义化版本）等
• 多语言支持：内置多种语言环境
• 本地服务器运行：可通过浏览器、cURL、应用程序等调用
• 交互式编辑器：带指令自动补全功能，内嵌GraphiQL
• API扩展支持：可代理现有GraphQL API并使用虚假数据扩展其功能

使用场景和适用范围

• 前端开发：在后端API未完成时，快速生成模拟数据进行前端调试
• API设计：通过模拟数据验证GraphQL schema设计的合理性
• 测试：为自动化测试提供可预测的虚假数据
• 演示：展示API功能时使用真实格式的模拟数据

详细使用方法和配置说明

基本命令格式

sh
graphql-faker [options] [SDL file]

[SDL file]：GraphQL SDL文件路径。若省略，Faker将使用默认文件名。

选项说明

特殊使用说明

在--forward-headers选项后指定[SDL file]时，需添加--以明确其为文件而非头信息，例如：

sh
graphql-faker --extend http://example.com/graphql --forward-headers Authorization -- ./temp.faker.graphql

若其他选项之后指定文件，则无需--：

sh
graphql-faker --forward-headers Authorization --extend http://example.com/graphql ./temp.faker.graphql

快速使用示例

1. 基于示例SDL模拟GraphQL API并打开交互式编辑器

sh
graphql-faker --open

注：可指定不存在的SDL文件名，Faker将使用示例SDL，可在交互式编辑器中编辑。

2. 使用扩展SDL扩展SWAPI的真实数据

sh
graphql-faker ./ext-swapi.graphql --extend http://swapi.apis.guru

3. 使用扩展SDL扩展GitHub API的真实数据（需https://developer.github.com/early-access/graphql/guides/accessing-graphql/#generating-an-oauth-token%EF%BC%89

sh
graphql-faker ./ext-gh.graphql --extend https://api.github.com/graphql \
--header "Authorization: bearer <TOKEN>"

Docker部署示例

基本运行

sh
docker run -p=9002:9002 apisguru/graphql-faker [options] [SDL file]

指定自定义SDL文件

挂载包含SDL文件的目录到容器的/workdir：

sh
docker run -v=${PWD}:/workdir apisguru/graphql-faker path/to/schema.sdl

注：由于进程在容器内运行，--open选项不生效。

工作原理

通过@fake指令指定虚假数据生成方式，若60+种内置虚假数据类型不够用，可使用@examples指令提供示例值，使用@listLength指令指定数组返回项数量。可将指令添加到任何字段或自定义标量定义中：

graphql
type Person {
  name: String @fake(type: firstName)  # 生成名
  gender: String @examples(values: ["male", "female"])  # 从示例值中选择
  pets: [Pet] @listLength(min: 1, max: 10)  # 返回1-10个Pet对象
}

编辑器提供自动补全功能，无需记忆或查阅文档。