nikba/directus-api-laravel

Laravel 10.x 版本的 Directus v8.8.1 API 包装器

v1.1 2023-10-15 05:37 UTC

This package is auto-updated.

Last update: 2024-09-15 07:36:30 UTC


README

Packagist Version Directus Version Laravel Version

此包简化了在 Laravel 应用程序中消费 Directus 无头 CMS REST API。

如果您正在寻找不使用 Laravel 的 Directus API 包装器,请参阅 nikba/directus-api

安装

安装 Directus-API 的推荐方法是通过 Composer

composer require nikba/directus-api-laravel

在 Laravel 中,更新 config/app.php 提供者数组以包含服务提供者

Nikba\Directus\Laravel\DirectusServiceProvider::class,

配置

默认情况下,该包配置为从您的 .env 文件中使用以下值

  • DIRECTUS_URL - 您 Directus 实例的基本 URL。
  • DIRECTUS_PROJECT - 您希望使用的 Directus 项目。

身份验证

您可以通过以下方式提供身份验证

  1. DIRECTUS_API_KEY - Directus 为用户生成的密钥。

或者

  1. DIRECTUS_USERNAME - Directus 用户名。DIRECTUS_PASSWORD - 您 Directus 用户的密码。

如果没有提供这些身份验证选项,将使用访客访问。

Laravel 配置文件

如果您更喜欢使用配置文件,可以通过运行此命令发布默认配置

php artisan vendor:publish --provider="Nikba\Directus\Laravel\DirectusServiceProvider"

这将创建一个位于 config/directus.php 的配置文件。

使用方法

要使用 API 包装器,您可以使用依赖注入来解析它

public function __construct(Directus $directus)
{
    $this->api = $directus;
}

或者使用辅助函数

directus() // or directus('connection')

理解 API

要深入了解 API 的工作原理,请参阅 nikba/directus-api