robertgarrigos/backdrop-headless-client

Laravel 5 REST API 客户端,用于 backdrop cms 网站的无头模块。

2.0.0-beta.4 2020-04-27 10:13 UTC

This package is auto-updated.

Last update: 2024-09-09 07:42:32 UTC


README

Latest Version on Packagist Build Status Scrutinizer Code Quality Total Downloads

这是一个 Laravel 包,允许您从配置了无头模块的 backdrop cms 网站中提取数据。因此,您可以将 backdrop 网站作为后端,Laravel 作为前端。

兼容性

本包的 v. 1.* 版本与 Laravel 5.8 兼容

本包的 v. 2.* 版本与 Laravel 7.* 兼容

安装

您可以通过 composer 安装此包

composer require robertgarrigos/backdrop-headless-client

可选地,您可以使用 artisan vendor:publish --tag=backdrop-config 发布一个配置文件。

您需要在 .env 文件中添加 backdrop api url 的配置值,如下

BACKDROP_API_SERVER="https://example.com"

使用方法

要使用此包,您需要安装并配置一个backdrop cms网站,并安装无头模块,该模块负责创建 JSON 端点。

您可以通过控制器访问这些端点

/* Nodes (v2): /api/v2/node/{type}/{id} */

$node = Backdrop::getNode($type, $id);

/* Terms: /api/{vocabulary}/term/{id} */

$term = Backdrop::getTerm($vocabulary, $id);

/* Views (v2): /api/v2/views/{view_name}/{display_id}/{contextual_arguments}{filter_arguments} */

$view = Backdrop::getView($view, $display_id, $args);

/* Paragraphs (v3): /api/v3/paragraphs/{id} */

$paragraph = Backdrop::getParagraph($id);

请阅读我关于此包的博客文章,以深入了解其工作原理和使用方法。

更新日志

请查看更新日志以获取最近更改的更多信息。

贡献

请查看贡献指南以获取详细信息。

安全

如果您发现任何安全相关的问题,请发送电子邮件至robert@garrigos.cat,而不是使用问题跟踪器。

鸣谢

许可

MIT 许可证 (MIT)。请参阅许可证文件以获取更多信息。

Laravel 包模板

本包使用Laravel 包模板生成。