Graphlient 使用教程

1. 项目介绍

Graphlient 是一个更友好的 Ruby GraphQL 客户端，基于 graphql-client 构建，提供了更好的默认设置、更一致的错误处理，并使用 Faraday HTTP 客户端。Graphlient 旨在简化消费基于 GraphQL 的 API 的过程，特别适合 Ruby 开发者。

2. 项目快速启动

安装

首先，将 Graphlient 添加到你的 Gemfile 中：

gem 'graphlient'

然后运行 bundle install 来安装 Gem。

使用

创建一个新的 Graphlient 客户端实例，并指定 GraphQL API 的 URL 和可选的请求头：

client = Graphlient::Client.new('https://test-graphql.biz/graphql', headers: { 'Authorization' => 'Bearer 123' })

执行查询：

response = client.query do
  query do
    invoice(id: 10) do
      id
      total
      line_items do
        price
        item_type
      end
    end
  end
end

获取查询结果：

puts response.data.invoice.line_items.first.price

3. 应用案例和最佳实践

错误处理

Graphlient 提供了详细的错误处理机制，确保在查询失败时能够捕获并处理错误。以下是一个错误处理的示例：

begin
  response = client.query do
    query do
      invoice(id: 10) do
        id
        total
        line_items do
          price
          item_type
        end
      end
    end
  end
rescue Graphlient::Errors::GraphQLError => e
  puts "GraphQL Error: #{e.message}"
rescue Graphlient::Errors::ServerError => e
  puts "Server Error: #{e.message}"
end

参数化查询

Graphlient 支持参数化查询，允许你动态传递变量：

query = <<-GRAPHQL
  query($ids: [Int]) {
    invoices(ids: $ids) {
      id
      fee_in_cents
    }
  }
GRAPHQL

variables = { ids: [42] }

response = client.query(query, variables)

4. 典型生态项目

Faraday

Graphlient 使用 Faraday 作为 HTTP 客户端，Faraday 是一个灵活的 HTTP 客户端库，支持多种适配器（如 Net::HTTP、Excon 等）。你可以通过配置 Faraday 来定制 Graphlient 的 HTTP 请求行为。

graphql-client

Graphlient 基于 graphql-client 构建，graphql-client 是一个用于执行 GraphQL 查询的 Ruby 库。Graphlient 在此基础上提供了更友好的 API 和更强大的错误处理机制。

RSpec

在测试中使用 Graphlient 时，可以结合 RSpec 进行集成测试。以下是一个简单的 RSpec 测试示例：

require 'spec_helper'

describe App do
  include Rack::Test::Methods

  def app
    # 你的 Rack 应用
  end

  let(:client) do
    Graphlient::Client.new('http://test-graphql.biz/graphql') do |client|
      client.http do |h|
        h.connection do |c|
          c.adapter Faraday::Adapter::Rack, app
        end
      end
    end
  end

  context 'an invoice' do
    let(:result) do
      client.query do
        query do
          invoice(id: 10) do
            id
          end
        end
      end
    end

    it 'can be retrieved' do
      expect(result.data.invoice.id).to eq 10
    end
  end
end

通过以上步骤，你可以快速上手并使用 Graphlient 进行 GraphQL API 的开发和测试。