GraphQL Guard 项目使用教程

GraphQL Guard 项目使用教程

graphql-guardSimple authorization gem for GraphQL :lock:项目地址:https://gitcode.com/gh_mirrors/gr/graphql-guard

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

GraphQL Guard 是一个用于 GraphQL 的简单授权 gem。以下是其基本的目录结构和各部分介绍：

graphql-guard/
├── lib/
│   ├── graphql/
│   │   ├── guard.rb
│   │   └── testing.rb
│   └── graphql-guard.rb
├── spec/
│   ├── guard_spec.rb
│   └── spec_helper.rb
├── Gemfile
├── Gemfile.lock
├── README.md
├── graphql-guard.gemspec
└── .gitignore

• lib/: 包含项目的主要代码文件。
  • graphql/guard.rb: 实现 GraphQL Guard 的核心功能。
  • graphql/testing.rb: 提供测试支持。
  • graphql-guard.rb: 主入口文件。
• spec/: 包含测试文件。
  • guard_spec.rb: 针对 guard 功能的测试。
  • spec_helper.rb: 测试辅助文件。
• Gemfile: 定义项目依赖。
• Gemfile.lock: 锁定依赖版本。
• README.md: 项目说明文档。
• graphql-guard.gemspec: 项目 gem 的规范文件。
• .gitignore: 定义 Git 忽略的文件和目录。

2. 项目的启动文件介绍

GraphQL Guard 的启动文件主要是 lib/graphql-guard.rb。这个文件是项目的入口点，负责加载和初始化 GraphQL Guard 的主要功能。

require "graphql/guard"
require "graphql/guard/testing"

这个文件引入了 graphql/guard 和 graphql/guard/testing 模块，确保项目的主要功能和测试功能都能正常加载。

3. 项目的配置文件介绍

GraphQL Guard 的配置主要通过 Gemfile 和 graphql-guard.gemspec 文件进行。

Gemfile

Gemfile 定义了项目的依赖关系：

source 'https://rubygems.org'

gem 'graphql', '~> 1.10'
gem 'graphql-guard', path: '.'

• graphql: 依赖于 GraphQL gem。
• graphql-guard: 依赖于本地开发的 GraphQL Guard gem。

graphql-guard.gemspec

graphql-guard.gemspec 文件定义了 gem 的详细信息和依赖：

Gem::Specification.new do |spec|
  spec.name          = "graphql-guard"
  spec.version       = "1.0.0"
  spec.authors       = ["exAspArk"]
  spec.summary       = "Simple authorization gem for GraphQL"
  spec.files         = Dir["lib/**/*", "README.md", "LICENSE"]
  spec.require_paths = ["lib"]

  spec.add_dependency "graphql", "~> 1.6"
  spec.add_development_dependency "bundler", "~> 1.15"
  spec.add_development_dependency "rake", "~> 10.0"
  spec.add_development_dependency "rspec", "~> 3.0"
end

• name: gem 的名称。
• version: gem 的版本。
• authors: 作者信息。
• summary: 简短描述。
• files: 包含的文件。
• require_paths: 需要加载的路径。
• add_dependency: 生产环境依赖。
• add_development_dependency: 开发环境依赖。

通过这些配置文件，可以确保 GraphQL Guard 在不同环境下都能正确运行和测试。

graphql-guardSimple authorization gem for GraphQL :lock:项目地址:https://gitcode.com/gh_mirrors/gr/graphql-guard