#REST API 数据源

#介绍

用于接入 REST API 来源的数据。

#安装

该插件为商业插件，详细的激活方式请参考：商业插件激活指南

#添加 REST API 源

激活插件之后，在数据源管理的 Add new 下拉菜单中选择 REST API。

配置 REST API 源

#添加 Collection

RESTful 的资源就是 NocoBase 的 Collection，例如 Users 资源

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

映射到 NocoBase API 里的配置为

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

完整的 NocoBase API 设计规范参考 API 文档

查看「NocoBase API - Core」章节

REST API 数据源的 Collection 配置如下

#List

配置查看资源列表的接口映射

#Get

配置查看资源详情的接口映射

#Create

配置创建资源的接口映射

#Update

配置更新资源的接口映射

#Destroy

配置删除资源的接口映射

其中 List 和 Get 是 必须配置的两个接口。

#调试 API

#请求参数对接

示例: 为 List 接口配置分页参数（如果第三方 API 本身不支持分页，则以取到的列表数据来分页）。

请注意，只有在接口中已添加的变量才会生效。

可以点击 Try it out 进行调试，查看响应结果。

#响应格式转换

第三方 API 的响应格式可能并不是 NocoBase 标准，需要转换之后才能正确的在前端显示。

根据第三方 API 的响应格式调整转换规则，使其符合 NocoBase 输出标准。

调试流程说明

#异常信息转换

第三方 API 出现异常，响应的异常信息格式可能不是 NocoBase 标准，需要转换之后才能正确的在前端显示。

未配置异常信息转换时，默认转换为包含 http 状态码的异常信息。

配置异常信息转换后，使其符合 NocoBase 输出标准，前端可以正确展示第三方 API 的异常信息。

#变量

REST API 数据源提供了三类变量用于接口的对接

• 数据源自定义变量
• NocoBase 请求
• 第三方响应

#数据源自定义变量

#NocoBase 请求

• Params：URL 查询参数（Search Params），各个接口的 Params 有所不同；
• Headers：请求体，主要提供了一些 NocoBase 自定义的 X- 信息；
• Body：请求的 Body；
• Token：当前 NocoBase 请求的 API token。

#第三方响应

目前提供的只有响应的 Body

各个接口对接时可用变量如下：

#List

#Get

#Create

#Update

#Destroy

#配置字段

从适配的资源的 CRUD 接口的数据中，提取字段的元数据（Fields）作为 collection 的字段。

提取字段元数据。

字段及预览。

编辑字段（和其他数据源的方式类似）。

#添加 REST API 数据源区块

Collection 配置好了之后，就可以去界面添加区块了。