GraphQL Schema Comparator 使用教程

GraphQL Schema Comparator 使用教程

graphql-schema_comparatorGet changes between two GraphQL schemas 🤖项目地址:https://gitcode.com/gh_mirrors/gr/graphql-schema_comparator

1. 项目的目录结构及介绍

GraphQL Schema Comparator 是一个用于比较两个 GraphQL 模式（schema）之间差异的开源项目。以下是该项目的目录结构及其介绍：

graphql-schema_comparator/
├── bin/
│   └── schema_comparator       # 命令行工具
├── gemfiles/
├── lib/
│   └── graphql/
│       └── schema_comparator/  # 核心逻辑代码
├── test/                       # 测试文件
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── graphql-schema_comparator.gemspec

目录结构介绍

• bin/: 包含命令行工具 schema_comparator。
• gemfiles/: 存放 Gemfile 相关文件。
• lib/graphql/schema_comparator/: 项目的核心逻辑代码。
• test/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 行为准则。
• Gemfile: Ruby 项目的依赖管理文件。
• LICENSE.txt: 项目许可证。
• README.md: 项目说明文档。
• Rakefile: Rake 任务配置文件。
• graphql-schema_comparator.gemspec: 项目的 gemspec 文件。

2. 项目的启动文件介绍

项目的启动文件是 bin/schema_comparator，这是一个命令行工具，用于比较两个 GraphQL 模式。以下是该文件的简要介绍：

#!/usr/bin/env ruby

require 'graphql/schema_comparator'

old_schema = ARGV[0]
new_schema = ARGV[1]

result = GraphQL::SchemaComparator.compare(old_schema, new_schema)

puts result

启动文件介绍

• #!/usr/bin/env ruby: 指定使用 Ruby 解释器。
• require 'graphql/schema_comparator': 引入 graphql/schema_comparator 库。
• old_schema = ARGV[0] 和 new_schema = ARGV[1]: 从命令行参数中获取旧模式和新模式。
• result = GraphQL::SchemaComparator.compare(old_schema, new_schema): 调用 compare 方法比较两个模式。
• puts result: 输出比较结果。

3. 项目的配置文件介绍

项目的配置文件主要是 Gemfile 和 graphql-schema_comparator.gemspec。

Gemfile

Gemfile 是 Ruby 项目的依赖管理文件，定义了项目所需的 gem 包及其版本。

source 'https://rubygems.org'

gem 'graphql-schema_comparator'

graphql-schema_comparator.gemspec

graphql-schema_comparator.gemspec 是项目的 gemspec 文件，包含了项目的元数据和依赖信息。

Gem::Specification.new do |spec|
  spec.name          = "graphql-schema_comparator"
  spec.version       = "0.1.0"
  spec.authors       = ["Marc-Andre Giroux"]
  spec.email         = ["mgiroux0@gmail.com"]
  spec.summary       = %q{Get changes between two GraphQL schemas}
  spec.description   = %q{GraphQL::SchemaComparator takes two GraphQL schemas and outputs a list of changes between versions}
  spec.homepage      = "https://github.com/xuorig/graphql-schema_comparator"
  spec.license       = "MIT"

  spec.files         = `git ls-files -z`.split("\x0")
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 

graphql-schema_comparatorGet changes between two GraphQL schemas 🤖项目地址:https://gitcode.com/gh_mirrors/gr/graphql-schema_comparator