JIRA SOAP API 文档？ [关闭]答案

【问题标题】：JIRA SOAP API documentation? [closed]JIRA SOAP API 文档？ [关闭]
【发布时间】：2010-09-21 16:36:01
【问题描述】：

我正在构建一些自定义工具来处理 JIRA 安装，并且公开的 SOAP API 很棒，除了没有指定任何参数。

例如getIssue的原型是：

RemoteIssue getIssue (string in0, string in1);

所有的 SOAP RPC 方法都遵循这个约定，所以如果没有文档，我很难弄清楚要传递很多这些方法。

有人知道权威的 API 文档指南吗？

【问题讨论】：

我使用 API 搜索可能的方法名称，然后阅读源代码以了解实际预期的内容。

标签： soap automation jira

【解决方案1】：

找到javadoc：

http://docs.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/index.html?com/atlassian/jira/rpc/soap/JiraSoapService.html

【讨论】：

我一定是有点不熟练，但我对这个文档并不完全满意。我几乎与您的配置相同，我想使用 createIssue 方法。为此，我创建了一个 RemoteIssue 对象的实例，并设置了以下参数：类型、摘要、项目、受让人、描述和优先级，它们都是字符串。但是我必须为类型设置什么值？ RemoteIssueType.name ？远程问题类型.id ？总结、项目等呢？我在哪里可以找到这方面的准确文档？感谢您的帮助
我用这个 API 做了很多工作——就个人而言，一旦你开始了解它的工作原理，而不是公开了哪些方法，它的文档几乎毫无用处。最好的方法是获取 Jira 的源代码（如果您因为正在针对试用版进行开发而无法访问源代码，那么我建议您购买 10 美元的美国入门版，这样您就可以访问所有源代码） .通过源代码，很容易看到每个参数的用途，以及每个调用的期望。

【解决方案2】：

我发现直觉参数应该是什么非常简单。根据你的复杂程度，你可能会猜到你应该通过什么。

不过有一个非常重要的（这是带有 SOAPpy 的 Python）：

self.proxy = WSDL.Proxy( jiraUrl )
self.token = self.proxy.login(self.username, self.password)
...
issues = self.proxy.getIssuesFromFilter(self.token, args[0])

从 login() 方法获取令牌后，您需要将其作为参数传递给所有其他 SOAP 调用。弄清楚之后，就很容易弄清楚参数应该是什么（例如，getIssuesFromFilter 应该将 filterId 作为它的另一个参数）

【讨论】：

【解决方案3】：

请参阅 http://confluence.atlassian.com/display/JIRA/JIRA+RPC+Services 了解所有 JIRA RPC 服务

【讨论】：

【解决方案4】：

您找到的 javadoc 链接是正确的。您还应该知道，并非所有内容都通过 SOAP 或 RPC 接口公开，但您可以使用 REST 接口执行任何操作。不幸的是，REST 接口没有很好的文档记录，但是您可以使用 HTML 流量检查器工具（例如 IE 的 Fiddler）来获取从 Web 界面发送到服务器的实际 POST 数据，并将特定呼叫的接口拼凑在一起需要。并不总是最简单的方法，但它确实有效。

【讨论】：