Flutter Webflow API集成插件webflow_api的使用

Flutter Webflow API集成插件webflow_api的使用

这个Webflow API包旨在简化与Webflow内容管理系统（CMS）的通信。

该包可以用于开发管理Webflow站点内容的管理员应用，例如博客、活动等。

该包通过HTTPS方法与Webflow API进行通信。该包的设计灵感来源于官方的Webflow API npm包。

此包并未得到Webflow的官方支持。

特性

该包提供了以下功能：

• 获取集合
• 按集合ID获取集合
• 获取集合中的项目
• 按项目ID获取集合中的项目
• 创建新的集合项目
• 删除集合项目
• 更新项目的字段

开始使用

要设置该包，请首先安装包。

flutter pub add webflow_api

1. 然后生成一个Webflow API令牌。 您可以在官方Webflow文档中找到说明。

2. 从Webflow项目设置仪表板检索Webflow项目ID（站点ID）。

3. 设置Webflow对象。

import 'package:webflow_api/webflow_api.dart';

const siteId = "插入站点ID";
const authToken = "插入身份验证令牌";

void main() async {
  Webflow webflow = Webflow(token: authToken, siteId: siteId);
}

官方CMS API参考可在此处找到。 注意，当前此包并未实现所有API方法。

使用

设置

const siteId = "插入站点ID";
const authToken = "插入身份验证令牌";
Webflow webflow = Webflow(token: authToken, siteId: siteId);

获取所有集合

// 获取所有CMS集合
List<Collection> collections = await webflow.collections();
// 显示第一个集合的ID和字段
print(collections[0].id);
print(collections[0].fields);

按ID获取项目

// 按ID从集合中获取项目
const collectionId = "插入集合ID";
const itemId = "插入项目ID";
ItemsResponse fetchedItem = await webflow.item(collectionId: collectionId, itemId: itemId);
// 打印获取的项目名称和slug
print(fetchedItem.items[0].name);
print(fetchedItem.items[0].slug);

额外信息

该包由Ahmed ElBatanony开发， 作为Innopolis大学的Flutter课程的一部分。

完整示例代码

以下是完整的示例代码，展示了如何使用webflow_api插件来执行各种操作。

import 'package:webflow_api/webflow_api.dart';

const siteId = "插入站点ID";
const authToken = "插入身份验证令牌";

void main() async {
  Webflow webflow = Webflow(token: authToken, siteId: siteId);

  const collectionId = "插入集合ID";

  // 列出所有站点集合
  List<Collection> collections = await webflow.collections();
  print(collections[0].id);
  print(collections[0].fields);

  // 按ID检索集合
  Collection collection = await webflow.collection(collectionId);
  print(collection.name);
  print(collection.fields[0].name);
  print(collection.fields[0].id);

  // 获取集合项并带有限制和偏移量
  ItemsResponse itemResponse = await webflow.items(collectionId, limit: 3, offset: 2);
  print(itemResponse.count);
  print(itemResponse.total);
  print(itemResponse.items[0].name);
  print(itemResponse.items[0].id);
  print(itemResponse.items[0].slug);
  print(itemResponse.items[0].json);

  // 按ID获取项目
  const itemId = "插入项目ID";
  ItemsResponse fetchedItem = await webflow.item(collectionId: collectionId, itemId: itemId);
  print(fetchedItem.items[0].name);
  print(fetchedItem.items[0].slug);

  // 创建一个新的集合项
  Item newItem = await webflow.createItem(
      collectionId: collectionId, fields: {"name": "插入新项目名称"});
  print(newItem.id);
  print(newItem.name);
  print(newItem.json);

  // 按ID删除项目
  int removedCount = await webflow.removeItem(collectionId: collectionId, itemId: itemId);
  print(removedCount);

  // 更新项目的字段
  Item updatedItem = await webflow.updateItem(
      collectionId: collectionId,
      itemId: itemId,
      fields: {"name": "插入更新后的项目名称"});
  print(updatedItem.json);
}