SuperAPI AI 工具集

confluence

编程与开发

查看项目

更新于 10-15 21:49

技能介绍

用途:该技能为 Atlassian Confluence 提供专家级协助,Confluence 是面向 Jira 用户的 wiki,擅长结构化文档与深度 Jira 集成(如嵌入实时 Jira 表格)。适用场景包括企业技术文档集中化(系统架构、工程 runbook、设计决策)、通过 REST API v2 从 Markdown 或 CI/CD 流水线自动发布文档、使用 Atlassian Document Format(ADF)创建含代码块、表格与提示宏的富结构文档,以及将工程需求关联到 Jira 冲刺与问题。

主要能力:通过 Confluence Cloud REST API v2 查询与创建页面;使用存储格式(XHTML)编写正文,支持 info 等结构化宏;使用 CQL(Confluence Query Language)跨空间搜索页面;按标准 ADR 布局记录架构决策。

使用方式:查询页面内容可用 curl 调用 GET https://mycompany.atlassian.net/wiki/api/v2/pages/{page-id},配合 -u "developer@example.com:$CONFLUENCE_API_TOKEN" 与 Accept: application/json。创建页面可用 Python requests 向 https://your-company.atlassian.net/wiki/api/v2/pages 发送 POST,payload 含 spaceId、status、title 及 body(representation 为 storage)。搜索可用 curl 调用 /wiki/rest/api/content/search?cql=...。

最佳实践:自动化脚本优先使用 REST API v2;按架构、Runbook、ADR、事后复盘组织空间层级;从 CI/CD 自动发布 API 文档与 schema;使用最小权限的 Atlassian API Token。避免保留过时文档、在页面中存放明文凭据、粘贴无格式文本。

限制与排错:401 通常因使用普通密码而非 API Token,需在 id.atlassian.com 生成;403 因页面权限限制,需向空间管理员申请;导出时第三方插件宏可能无法渲染,可替换为标准 Markdown 或 HTML 存储格式。具体收费、价格与平台支持范围暂未提供。