CraftQL 使用教程

CraftQL 使用教程

craftqlA CLI tool to visualize GraphQL schemas and to output a graph data structure as a graphviz .dot format项目地址:https://gitcode.com/gh_mirrors/cra/craftql

项目介绍

CraftQL 是一个为 Craft CMS 提供的即插即用的 GraphQL 服务器。通过零配置，CraftQL 允许你通过熟悉的 GraphQL 接口访问 Craft 的所有功能。CraftQL 支持多种 Craft CMS 的特性，如自定义字段、图像转换、草稿等。

项目快速启动

安装

首先，确保你已经安装了 Craft CMS。然后，通过 Composer 安装 CraftQL：

composer require markhuot/craftql

配置

安装完成后，你需要在 Craft CMS 的控制面板中启用 CraftQL 插件。

示例查询

安装并启用 CraftQL 后，你可以通过以下示例查询测试你的安装：

{
  helloWorld
}

如果一切正常，你应该会收到一个 "Hello World" 的响应。接下来，你可以使用 GraphQL 查询 Craft CMS 的内容：

{
  entries(section: [news]) {
    title
    url
    body
  }
}

应用案例和最佳实践

自定义字段

CraftQL 允许你通过自定义字段扩展 GraphQL 模式。例如，如果你有一个自定义字段 customField，你可以这样定义它：

Event::on(\craft\base\Field::class, 'craftQlGetFieldSchema', function ($event) {
    $field = $event->sender;
    $object = $event->schema->createObjectType('MapPoint')
        ->addStringField('lat')
        ->addStringField('lng')
        ->addStringField('zoom');
    $event->schema->addField($field)->type($object);
});

图像转换

你可以通过指定参数来请求图像转换。例如，如果你有一个图像字段 imageFieldHandle，你可以这样请求一个缩略图：

{
  entries {
    on Post {
      imageFieldHandle {
        thumbnail: url(transform: thumb)
      }
    }
  }
}

典型生态项目

CraftQL 可以与其他 Craft CMS 插件和工具集成，例如：

• SEOmatic: 一个用于管理 SEO 元数据的插件。
• Redactor: 一个强大的富文本编辑器插件。
• Sprout Forms: 一个表单生成器插件。

这些插件可以与 CraftQL 一起使用，提供更丰富的功能和更好的用户体验。

---

通过本教程，你应该已经了解了如何安装、配置和使用 CraftQL，以及如何通过自定义字段和图像转换来扩展其功能。希望你能充分利用 CraftQL 提供的强大功能，为你的 Craft CMS 项目带来更多的可能性。

craftqlA CLI tool to visualize GraphQL schemas and to output a graph data structure as a graphviz .dot format项目地址:https://gitcode.com/gh_mirrors/cra/craftql