SuperAPI AI 工具集

jira-api

编程与开发

查看项目

更新于 10-15 20:35

技能介绍

用途:为 Jira Cloud 的 REST API v3 提供权威参考,覆盖端点、认证、请求/响应格式、JQL 查询语言,以及程序化自动化与集成的最佳实践。

主要能力:基础 URL 为 https://{jira-instance}.atlassian.net/rest/api/3/,数据格式为 JSON,v3 为最新版本。支持 Basic Auth(API token,非密码)与 OAuth 2.0。核心端点包括问题操作(获取、创建、更新、删除、评论)、搜索与过滤(JQL)、项目、用户、工作流与转换、自定义字段、Webhook。支持 expand 参数(changelog、transitions、editmeta、names)与字段选择,分页通过 startAt/maxResults 实现。富文本使用 Atlassian Document Format(ADF),项目提供 JiraDocumentBuilder 简化构建。

使用方式:认证使用 Authorization: Basic {base64(email:token)},并设置 Accept 与 Content-Type 为 application/json。示例:GET /rest/api/3/issue/{issueIdOrKey};搜索 GET /rest/api/3/search?jql=project=PROJ AND status="In Progress"&maxResults=50。项目内用法:from jira_tool.client import JiraClient; client = JiraClient(); issue = client.get_issue("PROJ-123")。JiraClient 支持自动重试(429、500、502、503、504)与指数退避。

适用场景:Jira 问题查询与批量更新、工作流转换、自定义字段发现与使用、状态时长分析、CSV 导出、Webhook 管理等自动化与集成任务。

限制:需要 Python 3.8+、requests 库、有效的 Jira Cloud 实例与 API token,环境变量 JIRA_BASE_URL、JIRA_USERNAME、JIRA_API_TOKEN。Jira Cloud 存在速率限制(认证请求通常约 10 请求/秒),响应含 X-RateLimit-* 头。自定义字段 ID 因实例而异。OAuth 2.0 需注册应用,流程更复杂。官方文档:https://developer.atlassian.com/cloud/jira/platform/rest/v3/。