ดาวน์โหลด SearchObjectGraphQL - ดาวน์โหลดซอร์สโค้ด SearchObjectGraphQL

SearchObjectGraphQL

ซอร์สโค้ดอื่น ๆ

1.0.0

ดาวน์โหลด

SearchObject::ปลั๊กอิน::GraphQL

ปลั๊กอิน SearchObject สำหรับ GraphQL Ruby

การติดตั้ง

เพิ่มบรรทัดนี้ลงใน Gemfile ของแอปพลิเคชันของคุณ:

 gem 'search_object_graphql'

แล้วดำเนินการ:

 $ bundle

หรือติดตั้งด้วยตัวเองเป็น:

 $ gem install search_object_graphql

ต้องการด้วยตนเองในโครงการของคุณ

 require 'search_object'
require 'search_object/plugin/graphql'

การพึ่งพาอาศัยกัน

SearchObject >= 1.2
Graphql >= 1.5

บันทึกการเปลี่ยนแปลง

การเปลี่ยนแปลงมีอยู่ใน CHANGELOG.md

การใช้งาน

เพียงรวม SearchObject.module และกำหนดตัวเลือกการค้นหาและประเภท:

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  type [ PostType ] , null : false

  scope { Post . all }

  option ( :name , type : String )       { | scope , value | scope . where name : value }
  option ( :published , type : Boolean ) { | scope , value | value ? scope . published : scope . unpublished }
end

จากนั้นคุณสามารถใช้ PostResolver เป็น GraphQL::Schema::Resolver:

 field :posts , resolver : PostResolver

ตัวเลือกจะถูกเปิดเผยเป็นอาร์กิวเมนต์ในแบบสอบถาม GraphQL:

 posts(name: 'Example') { ... }
posts(published: true) { ... }
posts(published: true, name: 'Example') { ... }

ตัวอย่าง

คุณสามารถดูตัวอย่างคุณลักษณะและปลั๊กอินที่สำคัญที่สุดได้ ที่นี่

คุณสมบัติ

เอกสารประกอบ

สามารถจัดทำเอกสารการค้นหาออบเจ็กต์ได้ เช่นเดียวกับตัวเลือก:

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  description 'Lists all posts'

  option ( :name , type : String , description : 'Fuzzy name matching' ) { ... }
  option ( :published , type : Boolean , description : 'Find published/unpublished' ) { ... }
end

ค่าเริ่มต้น

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  scope { Post . all }

  option ( :published , type : Boolean , default : true ) { | scope , value | value ? scope . published : scope . unpublished }
end

ตัวเลือกอาร์กิวเมนต์เพิ่มเติม

บางครั้งคุณจำเป็นต้องส่งตัวเลือกเพิ่มเติมไปยังวิธีอาร์กิวเมนต์ Graphql

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  scope { Post . all }

  option ( :published , type : Boolean , argument_options : { pundit_role : :read } ) { | scope , value | value ? scope . published : scope . unpublished }
end

การเข้าถึงวัตถุหลัก

บางครั้งคุณต้องการกำหนดขอบเขตการโพสต์ตามวัตถุหลัก สามารถเข้าถึงได้เป็นคุณสมบัติ object :

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  # lists only posts from certain category
  scope { object . posts }

  # ...
end

หากคุณต้องการบริบท GraphQL ก็สามารถเข้าถึงได้ในรูปแบบ context

การสนับสนุน Enum

 class PostSearch
  include SearchObject . module ( :graphql )

  OrderEnum = GraphQL :: EnumType . define do
    name 'PostOrder'

    value 'RECENT'
    value 'VIEWS'
    value 'COMMENTS'
  end

  option :order , type : OrderEnum , default : 'RECENT'

  def apply_order_with_recent ( scope )
    scope . order 'created_at DESC'
  end

  def apply_order_with_views ( scope )
    scope . order 'views_count DESC'
  end

  def apply_order_with_comments ( scope )
    scope . order 'comments_count DESC'
  end
end

การสนับสนุนรีเลย์

วัตถุการค้นหาสามารถใช้เป็นการเชื่อมต่อรีเลย์:

 class PostResolver < GraphQL :: Schema :: Resolver
  include SearchObject . module ( :graphql )

  type PostType . connection_type , null : false

  # ...
end