API ForeignKey

规格

标签	值
版本	0.1.0（更新于 2025-02-11）
开发者	Labii Inc.
类型	列
支持配置	是
支持只读视图	是
支持编辑视图	是
支持表单视图	是
支持默认值	是
支持导入	是
允许多个	是

概述

Labii 的 API ForeignKey 小插件从 API URL 获取数据并以单选下拉菜单显示，让用户可以将外部资源无缝集成到 Labii。此小插件简化了 Labii 记录与外部数据库、应用或服务的关联过程，并支持动态、实时地选择数据。通过配置 API 端点，用户可以轻松检索外部数据并与之交互，使 Labii 更灵活地适应需要外部引用的各种工作流程。

使用场景

• 显示第三方供应商潜在订单的批号。

配置

要使用此小插件，需要提供相应选项。

• Bearer Token - Bearer Token 或其他授权字符串。Bearer Token 是 OAuth 2.0 最常用的访问令牌类型。例如：Bearer eyJraWQiOiIy
• URL - 用于下载项目列表的 URL。
• Search Prefix - 搜索项目列表时使用的前缀。默认为空。
• Method - 下载项目列表时使用的 API 方法。默认为 GET。
• Results Key - 从 API 响应中提取结果的键。默认为 results。
• SID Key - 从 API 响应中提取 SID/ID 的键。默认为 id。
• Name Key - 从 API 响应中提取 Name 的键。默认为 name。
• Link - 记录详细信息页面的链接。使用 {SID} 替换记录的 sid/id。

示例

{
    "url": "http://127.0.0.1:8080/vendors/",
    "method": "get",
    "sid_key": "id",
    "name_key": "name",
    "results_key": "results",
    "authorization": "Bearer xxx",
    "search_prefix": "name__icontains"
}

视图

在以下视图中查看此小插件的界面。

只读视图

只读视图显示列的值。

编辑视图

编辑视图是用于修改值的界面。

此小插件不支持编辑视图。

表单视图

表单视图是集成到添加表单中的字段，用于在创建新记录时收集值。

表单视图与编辑视图相同。

数据

Labii 中的每个小插件都以独特的方式存储数据；请参阅以下内容，了解此小插件的数据存储方式。

数据格式

包含 sid 和 name 键的 JSON 对象。

{"sid": "", "name": ""}

默认值

列中的 Default Value 字段允许您指定创建记录时使用的默认值。

默认值应为包含 sid 和 name 键的 JSON 对象。

导入值

Import Value 是需要包含在 Excel 表格中的值，以便将其导入 Labii。

导入值应为包含 sid 和 name 键的 JSON 对象。