关于Bugzilla WebService接口

浏览数：71 / 时间：2015年06月09日

参考：http://www.bugzilla.org/docs/3.2/en/html/api/Bugzilla/WebService.html

API名称

Bugzilla::WebService - Bugzilla的Web Service接口

描述

这是外部程序想与Bugzilla发生交互的标准API，它提供了各模块的各种方式。当前访问该API的唯一方式是通过XML-RPC，相关标准可参看： http://www.xmlrpc.com/spec

Bugzilla WebServices的访问入口是Bugzilla安装目录中 xmlrpc.cgi 脚本文件。比如，如果你的 Bugzilla 位于 bugzilla.yourdomain.com，那么你的 XML-RPC 客户端就要访问 API : http://bugzilla.yourdomain.com/xmlrpc.cgi

方法调用

Bugzilla当前没有实现标准XML-RPC方法调用的扩展特性。方法以常规XML-RPC方式调用。方法以“packages”的形式进行分组，如Bug对应 Bugzilla::WebService::Bug。所以如果是 "get" in Bugzilla::WebService::Bug，在XML-RPC中应该是用Bug.get调用。

参数

除了标准的参数类型如int, string等外，XML-RPC还有两种数据结构 <struct> 及 <array>。

Structs

XML-RPC:

 <struct>
   <member>
     <name>fruit</name>
     <value><string>oranges</string></value>
   </member>
   <member>
     <name>vegetable</name>
     <value><string>lettuce</string></value>
   </member>
 </struct>

API文档里：

 { fruit => ‘oranges‘, vegetable => ‘lettuce‘ }

Arrays

以下示例代码中，[ 和 ] 用来代表数组的起止界定。

比如，XML-RPC中的数组

 <array>
   <data>
     <value><i4>1</i4></value>
     <value><i4>2</i4></value>
     <value><i4>3</i4></value>
   </data>
 </array>

在API文档里，会写成：

 [1, 2, 3]

Bugzilla WebService方法如何接收参数

所有的Bugzilla WebServices 函数以<struct>的形式接收参数。换句话说，所有函数都只接收单个参数，所有的参数都包含在这个参数中。API文档中列出的对应名称的参数意味着放在struct数据结构中。

帐号登陆

你可以使用 "login" in Bugzilla::WebService::User 接口来登陆 Bugzilla 账户。这会产生标准的HTTP cookies，在将来的调用中必须用到这个数据，所以你的XML-RPC客户端必须要能接收与发送cookies的处理能力。

方法稳定的、实验性的及不稳定的状态

Methods are marked STABLE if you can expect their parameters and return values not to change between versions of Bugzilla. You are best off always using methods markedSTABLE. We may add parameters and additional items to the return values, but your old code will always continue to work with any new changes we make. If we ever break aSTABLE interface, we‘ll post a big notice in the Release Notes, and it will only happen during a major new release.

Methods (or parts of methods) are marked EXPERIMENTAL if we believe they will be stable, but there‘s a slight chance that small parts will change in the future.

Certain parts of a method‘s description may be marked as UNSTABLE, in which case those parts are not guaranteed to stay the same between Bugzilla versions.