玩转飞书项目插件开发之二---同步Jira Issue到飞书项目

1,178 阅读2分钟

在前面我们讲到了飞书项目插件开发的原理,并且已经创建了一个插件,那么接下来的章节我们就要实践一下,做一些实际场景的实战介绍,这样大家对于插件的开发能够有清晰的了解。

本节主要是介绍如何同步Jira Issue到飞书项目,并创建对应的缺陷工作项。

从Jira获取数据

获取API Token

首先,先创建一个API令牌,并将所创建的令牌保存供后续使用

image.png

创建Issue

创建完令牌之后,我们去创建一个Issue实例,并希望将此实例的内容同步至飞书项目的缺陷工作项。 image.png

Postman取数

创建完Jira Issue之后,我们需要获得Issue的信息,在这里我们通过Jira的API进行了数据的拉取,具体可以参考Jira的相关API说明。 image.png

如上所述,我们完成了从Jira取数的过程,现在就是要通过插件将获得到的消息在飞书项目创建一个缺陷实例

同步飞书项目

安装插件

前面我们已经获得了Jira Issue的详情信息,那么接下来我们就需要利用这些信息去飞书项目中创建一个缺陷工作项。 这里我们也是利用之前一节创建的插件进行此操作。

  1. 检查该插件权限,一定要记得申请创建工作项的权限。

image.png 2. 示例空间安装该插件,直接在插件市场搜索安装即可。

image.png

字段管理中配置关联Jira字段

在缺陷工作项的字段管理中,我们新建一个文本类型的字段Jira_ID,用此字段来存储Jira Issue的ID信息。在创建该字段时,我们将对接标识(field_alias)填写为“sync_field_id”。自定义字段的field_key是由系统生成的,这个不好控制,但是可以通过alias的方式来确定具体的字段。

image.png 如上图所示field_key为field_5ef12e, field_alias为sync_field_id。

以下将会是通过Postman的方式进行相关操作。

获取插件Token

首先是通过Plugin ID和Secret获取Token信息,后续将会把该Token放在请求的Header中。 image.png

创建缺陷实例

将前序步骤获得到的token放到请求的header中。并将Jira的summary映射为工作项的名称,描述映射为工作项的描述,Issue ID映射为Jira_ID。 Postman的请求参数如下图所示

image.png

image.png

创建成功之后会返回所创建实例的工作项id: 5018740550 此时,我们去飞书项目所在空间进行缺陷详情的查看:

image.png

按照上述步骤,已经成功从Jira同步一个Issue到飞书项目了,是不是很简单,赶紧来实战一下吧~