README

简介

这个库提供了一个 API 客户端，使您可以使用 Prismic 自定义类型 API 来读取和写入您的文档类型定义。

目前，您可以列出、读取、插入和更新文档类型。

客户端要求您使用（以及它返回的）随附的 Definition 值对象。

通常，您不会直接与客户端交互，而是将其作为构建过程的一部分，该过程会为您处理所有这些工作。这个客户端相当新，但它的主要用途很快将成为 netglue/prismic-cli 的一部分，这样您就可以轻松地同步本地开发文档定义与生产 Prismic 存储库中的定义（反之亦然）。

安装

唯一支持的安装方法是使用 composer

composer require --dev netglue/prismic-doctype-client

配置

客户端已被设计为与您喜欢的任何 PSR-18 HTTP 客户端和 PSR-7 和 PSR-17 实现一起工作。一旦您获得了自定义类型 API 的 API 令牌，您可以使用以下方式创建客户端：

<?php
use Prismic\DocumentType\BaseClient;

$client = new BaseClient(
    'some-token',
    'my-repository-name',
    $httpClient,     // \Psr\Http\Client\ClientInterface
    $requestFactory, // \Psr\Http\Message\RequestFactoryInterface
    $uriFactory,     // \Psr\Http\Message\UriFactoryInterface
    $streamFactory   // \Psr\Http\Message\StreamFactoryInterface
)

限制/路线图

身份验证

目前，身份验证只能通过您从 Prismic 存储库设置中创建/检索的永久访问令牌完成。不支持基于会话的令牌。

片段

对共享片段的 CRUD 操作尚未实现，但计划在未来的开发中实现。如果您真的需要这个功能，欢迎您贡献。

贡献

请随时参与开发。该项目使用 PHPUnit 进行测试，Psalm 进行静态分析，以及 Infection 进行突变测试。如果您想提交功能或修复，CI 应该会支持您；）

许可证

MIT 许可.

变更日志

请参阅 CHANGELOG.md。

netglue / prismic-doctype-client

维护者

详细信息

README

简介

安装

配置

限制/路线图

身份验证

片段

贡献

许可证

变更日志