bdunogier/ezplatform-graphql-bundle

此软件包已被废弃,不再维护。作者建议使用 ezsystems/ezplatform-graphql 软件包。

为 eZ Platform 开源 CMS 仓库提供的 GraphQL 服务器。

安装: 365

依赖项: 0

建议者: 0

安全: 0

星标: 13

关注者: 2

分支: 6

开放问题: 34

类型:ezplatform-bundle

v0.3.2 2018-12-19 10:00 UTC

README

此 Symfony 扩展为 eZ Platform 添加 GraphQL 服务器,该服务器是开源 CMS。它公开了两个端点。

域模式: /graphql

https://<host>/graphql

仓库域的图。它公开了基于内容类型组、内容类型和字段定义的域模型。用它来实现针对特定仓库结构的特定应用程序或网站。

示例:eZ Platform 网站。

注意:此功能需要额外的配置步骤。请参阅 域模式文档

仓库模式: /graphql/repository

https://<host>/graphql/repository

仓库公共 API 的图。它公开了来自仓库的值对象:内容、位置、字段、URL 别名等。它适用于管理员应用程序等,不仅限于特定仓库。

示例:eZ Platform 管理员 UI 扩展。

仓库模式文档

安装

使用 composer 安装软件包及其依赖项

composer require ezsystems/ezplatform-graphql

将扩展添加到 app/AppKernel.php(注意顺序,非常重要)

$bundles = array(
    // ...
    new BD\EzPlatformGraphQLBundle\BDEzPlatformGraphQLBundle(),
    new Overblog\GraphQLBundle\OverblogGraphQLBundle(),
    new AppBundle\AppBundle(),
);

将 GraphQL 路由配置添加到 app/config/routing.yml

overblog_graphql:
    resource: "@OverblogGraphQLBundle/Resources/config/routing/graphql.yml"

overblog_graphql_endpoint:
    path: /graphql
    defaults:
        _controller: Overblog\GraphQLBundle\Controller\GraphController::endpointAction
        _format: "json"

生成您的模式

运行生成 GraphQL 模式的命令

php bin/console ezplatform:graphql:generate-schema
php bin/console cache:clear

它将在 app/config/graphql/ezplatform 下生成许多 yaml 文件,这些文件基于您的内容类型。

GraphiQL

如果您想使用它,则必须单独安装图形 GraphQL 客户端 GraphiQL。作为开发者,您可能想这么做。

composer require --dev overblog/graphiql-bundle

OverblogGraphiQLBundle 添加到 dev 扩展

case 'dev':
    // ...
    $bundles[] = new Overblog\GraphiQLBundle\OverblogGraphiQLBundle();

将 GraphiQL 路由添加到 app/config/routing_dev.yml

overblog_graphql_graphiql:
    resource: "@OverblogGraphiQLBundle/Resources/config/routing.xml"

打开 http://<yourhost>/graphiql