使用Jira REST API创建问题:HTML转ADF方法咨询
将HTML转换为Jira ADF格式的方法
Jira Cloud的描述字段默认使用Atlassian Document Format (ADF),直接传入HTML内容会被当作纯文本显示标签,你可以通过以下几种方式完成HTML到ADF的转换:
1. 调用Jira REST API的转换端点
Jira提供了专门的HTML转ADF接口,发送POST请求到/rest/api/3/body/convert/html,请求体携带你的HTML内容即可获取对应的ADF结构。示例请求体:
{ "value": "<p>这是带有<b>加粗</b>和<i>斜体</i>的内容</p>", "representation": "html" }
把接口返回的ADF结构直接赋值给创建问题时的description字段即可。
2. 手动构建ADF结构
如果不想额外调用接口,可以手动将HTML元素映射为ADF节点,常见标签对应关系如下:
<p>→ ADF的paragraph节点<b>/<strong>→ 带bold标记的text节点<i>/<em>→ 带italic标记的text节点<ul>/<li>→bulletList节点嵌套listItem节点
示例:将<p>Hello <b>World</b></p>转换为ADF:
{ "version": 1, "type": "doc", "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "Hello " }, { "type": "text", "text": "World", "marks": [{"type": "bold"}] } ] } ] }
创建问题时,把这个JSON对象直接放到fields.description字段中。
3. 使用第三方开发库(针对编程场景)
如果用编程语言开发,可以借助现成的转换库:
- Python:使用
atlassian-python-api库中的HTML转ADF方法 - JavaScript:通过
@atlassian/adf-utils包提供的转换工具
完成转换后将结果传入Jira创建问题的接口即可。
内容的提问来源于stack exchange,提问作者Abdul Basit
相关产品推荐
相关产品推荐

