Bugzilla:BzAPI:CompatLayer: Difference between revisions

More about performance and the future of BzAPI compat
(Created page with "Until mid-2013, Bugzilla natively supported only older Web technologies, namely XMLRPC and JSONRPC. The BMO team created a new REST API in the summer of 2013 to provide a mode...")
 
(More about performance and the future of BzAPI compat)
 
Line 4: Line 4:


To ease the transition, we have created a native BzAPI compatibility layer ({{bug|880669}}) that acts almost exactly the same as BzAPI but will translate the queries to the native API layer. Thus clients who currently use BzAPI will just need to change
To ease the transition, we have created a native BzAPI compatibility layer ({{bug|880669}}) that acts almost exactly the same as BzAPI but will translate the queries to the native API layer. Thus clients who currently use BzAPI will just need to change
the REST URL to the built-in API (https://bugzilla.mozilla.org/bzapi/), which is slightly different from the native one (https://bugzilla.mozilla.org/rest/).
the REST URL to the built-in API (https://bugzilla.mozilla.org/bzapi/), which is somewhat different from the native one (https://bugzilla.mozilla.org/rest/).


If anything doesn't display properly, is missing, or generates an error of some kind, please file bugs under [https://bugzilla.mozilla.org/enter_bug.cgi?product=bugzilla.mozilla.org&component=Extensions%3A%20BzAPI%20Compatibility bugzilla.mozilla.org :: Extensions: BzAPI Compatibility].
If anything doesn't display properly, is missing, or generates an error of some kind, please file bugs under [https://bugzilla.mozilla.org/enter_bug.cgi?product=bugzilla.mozilla.org&component=Extensions%3A%20BzAPI%20Compatibility bugzilla.mozilla.org :: Extensions: BzAPI Compatibility].


We plan to leave the compat API in place for the foreseeable future, but we will not make any major changes nor enhancements to it. We will be working to enhance the native REST API instead with the upstream Bugzilla community. Thus any requests for improvements or new features will need to be directed the native API component under [https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=WebService Bugzilla :: WebService].
The compatibility layer should be viewed as a temporary solution only. The BMO team recommends updating applications that currently use BzAPI to use the native REST API as soon as possible. Not only will this prepare you for the eventual decommissioning of the BzAPI compatibility layer, but the native REST API is generally faster, since the compatibility layer is a wrapper around native REST.
 
We will not make any major changes nor enhancements to the compatibility layer, and at some point it will be removed, likely when we rewrite the native REST API to enhance its capabilities and improve its interface. Thus any requests for improvements or new features will need to be directed the native API component under [https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=WebService Bugzilla :: WebService].
Confirmed users
1,927

edits