创建 Piece 定义
本教程将指导你创建一个 Gelato Piece,包含一个获取随机冰淇淋口味的动作和一个监听新创建冰淇淋口味的触发器。假设你已经熟悉以下内容:
- Activepieces 本地开发 或 GitHub Codespaces
- TypeScript 语法
Piece 定义
首先,让我们为 Gelato 生成一个新的 Piece:
npm run cli pieces create
系统会询问三个问题来定义你的新 Piece:
Piece 名称:为你的 Piece 指定一个名称。该名称在 ActivePieces 生态系统中唯一标识你的 Piece。包名称:可选,为与你的 Piece 关联的 npm 包输入名称。如果留空,将使用默认名称。Piece 类型:根据你的意图选择 Piece 类型。如果它是为你量身定制的解决方案,选择”custom”;如果它是为了与更广泛的社区共享和使用的,选择”community”。
示例:
npm run cli pieces create
? 请输入 piece 名称:gelato
? 请输入包名称:@activepieces/piece-gelato
? 请选择 piece 类型:community
该 Piece 将生成在 packages/pieces/community/gelato/ 目录下,
src/index.ts 文件应包含以下代码:
import { PieceAuth, createPiece } from '@activepieces/pieces-framework';
export const gelato = createPiece({
displayName: 'Gelato',
logoUrl: 'https://cdn.activepieces.com/pieces/gelato.png',
auth: PieceAuth.None(),
authors: [],
actions: [],
triggers: [],
});