Bugzilla:BzAPI: Difference between revisions

No edit summary
Line 40: Line 40:
As the API is tweaked and revised, the version number in these URLs will increase, so updates don't break every single client immediately. However, old versions are not guaranteed to persist. Authors of API-using tools are strongly encouraged to join the [http://www.mozilla.org/community/developer-forums.html#tools mozilla.tools] mailing list to be kept up to date.
As the API is tweaked and revised, the version number in these URLs will increase, so updates don't break every single client immediately. However, old versions are not guaranteed to persist. Authors of API-using tools are strongly encouraged to join the [http://www.mozilla.org/community/developer-forums.html#tools mozilla.tools] mailing list to be kept up to date.


==Browse Interface==
==Browsing the API==


If the Accept: header of a request is set to text/html (as it is by an ordinary web browser) then the API will return YAML-HTML, which the browser can display. In other words, you can play with the API using just your browser and see results in a human-readable form. [https://api-dev.bugzilla.mozilla.org/latest/bug/35 Here is an example]. This is a good way to try out various calls and capabilities.
If the Accept: header of a request is set to text/html (as it is by an ordinary web browser) then the API will return YAML-HTML, which the browser can display. In other words, you can play with the API using just your browser and see results in a human-readable form. [https://api-dev.bugzilla.mozilla.org/latest/bug/35 Here is an example]. This is a good way to try out the various GET calls, even if you can't use it for POST or PUT. For that, the [https://addons.mozilla.org/en-US/firefox/addon/9780 Firefox "RESTClient" addon] is very useful.


== Authentication ==
== Authentication ==
Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti
4,925

edits