laraluke / statamic-api-select
该包的最新版本(1.0.0)没有可用的许可证信息。
1.0.0
2020-08-07 16:00 UTC
This package is auto-updated.
Last update: 2024-09-08 03:35:10 UTC
README
使用API端点为您的Select字段类型选项。
许可证
API Select需要许可证。
您可以在https://statamic.com/marketplace/addons/api-select购买一个。
当Statamic处于试用模式时,您可以在没有许可证的情况下使用API Select。
安装
使用Composer安装它。
composer require laraluke/statamic-api-select
发布资产
php artisan vendor:publish --provider="Laraluke\ApiSelectFieldtype\ServiceProvider"
使用API Select字段类型
将字段类型添加到您的字段集/蓝图。然后您需要配置以下设置
端点类型
这是为了定义您的端点值是URL还是配置变量。
端点
如果您的端点类型是URL,您的端点值将如下所示
https://jsonplaceholder.typicode.com/users
如果您的端点类型是配置变量,您的端点值将如下所示
endpoints.users
并且您的endpoints.php
文件可能如下所示
return [ 'users' => 'https://jsonplaceholder.typicode.com/users', ];
缓存持续时间
这是API请求在分钟内被缓存的时长。
如果您不想缓存结果,请将此值设置为0。
数据集键
如果您的数据集不在API响应的顶层,您可以使用点符号定义其位置。
所以如果您的API结果如下所示
{ "data": { "users": [] } }
您将设置数据集键值为
data.users
项目键
定义要作为选项值的唯一标识符。
所以如果您的API结果迭代如下所示
{ "id": 1, "name": "Leanne Graham", "username": "Bret", "email": "Sincere@april.biz", }
您可能将项目键设置为
id
项目标签
定义要作为选项标签的值。
所以如果您的API结果迭代如下所示
{ "id": 1, "name": "Leanne Graham", "username": "Bret", "email": "Sincere@april.biz", }
您可能将项目标签设置为
name
在模板中使用API Select值
假设您的API选择字段处理程序是api_select_users
,API响应如下所示
[ { "id": 1, "name": "Leanne Graham", "username": "Bret", "email": "Sincere@april.biz", }, { "id": 2, "name": "Ervin Howell", "username": "Antonette", "email": "Shanna@melissa.tv", } ]
单选API选择
{{ api_select_users.name }}
// Returns
Leanne Graham
多选API选择
{{ api_select_multi }}
{{ name }}
{{ /api_select_multi }}
// Returns
Leanne Graham
Ervin Howell